Skip to content

docs: add CONTRIBUTING.md#19

Merged
andresdefi merged 1 commit into
mainfrom
docs/contributing
May 22, 2026
Merged

docs: add CONTRIBUTING.md#19
andresdefi merged 1 commit into
mainfrom
docs/contributing

Conversation

@andresdefi
Copy link
Copy Markdown
Owner

Summary

Adds a CONTRIBUTING.md so new contributors have a single place to learn the architectural rules that aren't obvious from the code alone, plus the practical process for getting a PR landed.

What's in it

  • What appframe is / isn't - positioning + a short list of out-of-scope work to filter incoming PRs.
  • Issues vs PRs - nudges contributors toward shipping a PR rather than throwing requests over the wall. Reflects the practical maintainer-load reality.
  • Quick start + the rebuild / hard-refresh gotchas that anyone running the preview hits day one.
  • Project structure - 3 packages explained in 3 lines each.
  • The non-negotiables - 6 load-bearing architecture invariants (rich-envelope vs slim config, hydrate-not-init, atomic writes, slim persistence, no magic slug, no fallbacks for impossible states). Each anchored to a past incident or design decision documented in CLAUDE.md.
  • Code conventions - TS strict, ESM, no emojis, no em dashes, the comment philosophy.
  • UI / UX bar - including the requirement that any user-facing change must include screenshots, with screen recordings recommended for flow-based features.
  • MCP contributions - the 5 rules from CLAUDE.md (cover UI surface, discoverable IDs, merge-not-replace, descriptions name units, smoke-test end-to-end).
  • Testing, PR process, security reporting, recognition - short and practical.

Test plan

  • Markdown renders cleanly
  • Links resolve (CLAUDE.md, security advisories tab)
  • No em dashes, no emojis

🤖 Generated with Claude Code

Lean (~120 lines) doc covering the architectural invariants a
contributor would otherwise discover the hard way: the rich-envelope /
slim-config distinction, hydrate-not-init, the slim persistence
pattern, the MCP design rules. Anchored to CLAUDE.md for the deeper
"why" behind each rule.

Friendly framing on process: issues are welcome but PRs ship faster,
so contributors are nudged to bring an implementation rather than just
a request. Reflects the practical reality of maintaining solo
alongside other projects.

Adds the user-facing-changes-need-screenshots rule (mandatory for
anything visible in the UI; videos optional for flow-based features).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@andresdefi andresdefi merged commit 2e75df0 into main May 22, 2026
4 checks passed
@andresdefi andresdefi deleted the docs/contributing branch May 22, 2026 14:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant