Skip to content

docs: make the contributor quickstart actually run - #622

Closed
mikestankavich wants to merge 1 commit into
chore/tra-1128-align-ignore-block-and-split-process-docfrom
fix/tra-1219-contributing-quickstart-cannot-succeed
Closed

mikestankavich wants to merge 1 commit into
chore/tra-1128-align-ignore-block-and-split-process-docfrom
fix/tra-1219-contributing-quickstart-cannot-succeed

Conversation

@mikestankavich

Copy link
Copy Markdown
Contributor

Every command in the getting-started path was dead. A stranger following CONTRIBUTING.md failed at step 4 and never reached step 5. These are public repos, so that path is the first thing an outside contributor touches.

Stacked on #620. Base is chore/tra-1128-align-ignore-block-and-split-process-doc, not main, because #620 also edits CONTRIBUTING.md and branching from main would conflict on merge. Merge #620 first, then this retargets to main cleanly.

What was broken

The Quick Setup described an architecture the repo left behind — raw docker-compose plus go run cmd/migrate/main.go, predating just, direnv and the bootstrap step. Each of these was checked against the tree rather than assumed:

Documented Reality
cp backend/.env.example backend/.env no such file, and no env sample in that directory
cp frontend/.env.example frontend/.env same
go run cmd/migrate/main.go up no such path; migrations run through just
go test ./tests/integration -tags=integration no such directory; integration tests are in-package behind a build tag
go run cmd/server/main.go no such path; the entrypoint is backend/main.go
cd tests/api && pnpm test there is no top-level tests/ directory at all

just was not listed as a required tool, despite being the entry point for every workflow in the repo. Neither was direnv. pnpm appeared only as "Node.js 18+", though the repo uses pnpm exclusively and pins pnpm@9.12.3.

What it says now

The path the README documents and the justfile implements: configure .env.local, just bootstrap, just dev, just test. Every recipe and file named in the new text was confirmed to exist, including just backend test-integration and just test-contract.

The env explanation points at the README rather than restating it — there is one local env file holding connection parts, and duplicating that here would create the second source of truth this file already suffers from.

Also corrected — found by auditing the whole file

Fixing only the reported lines is how a file ends up correct at two points and wrong everywhere else, so the rest got the same treatment:

  • Adding an API endpoint pointed at backend/api/routes.go. The router is backend/internal/cmd/serve/router.go.
  • Database changes pointed at database/migrations/; it is backend/migrations/. The step that makes CI pass — just backend migrate-checksums — was missing entirely, so a contributor following this guide would land a migration that fails CI with no indication why.
  • The frontend section described Redux and Storybook. Neither is a dependency. The app uses zustand and TanStack Query.

Left alone deliberately

"Test the migration up and down" reads like more of the same rot, and it is correct — down migrations are still written, including for all four most recent. Checked before editing rather than swept up with the rest.

Verification

  • just validate — exit 0
  • Every repo path referenced in the file now resolves; audited by extracting and testing each one
  • Every just recipe named was confirmed present in just --list

What this does not fix

The underlying cause, which is item 3 on TRA-1219: nothing reads CONTRIBUTING.md. No gate, no session, no CI, and evidently no human since those env files stopped existing. This PR resets it to true; without a consumer it will drift again, and the next person to notice will be an outside contributor rather than us.

Refs: TRA-1219

🤖 Generated with Claude Code

https://claude.ai/code/session_01W7p2hFrE6ZFWS91XvyFQcV

TRA-1219. Every command in the getting-started path was dead. A stranger
following CONTRIBUTING.md failed at step 4 and never reached step 5.

The Quick Setup described an architecture the repo left behind: raw
docker-compose plus `go run cmd/migrate/main.go`, predating just, direnv
and the bootstrap step. Verified rather than assumed -- each of these was
checked against the tree:

  cp backend/.env.example      no such file, and no env sample in that dir
  cp frontend/.env.example     same
  go run cmd/migrate/main.go   no such path; migrations run via just
  go test ./tests/integration  no such dir; integration tests are
                               in-package behind a build tag
  go run cmd/server/main.go    no such path; the entrypoint is main.go
  cd tests/api && pnpm test    no top-level tests/ dir at all

`just` was not even listed as a required tool, though it is the entry
point for every workflow in the repo. Neither was direnv, and pnpm was
named only as "Node.js".

Replaced with the path the README documents and the justfile implements:
configure .env.local, just bootstrap, just dev, just test. Every recipe
and file named in the new text was confirmed to exist.

Also corrected, same rot, found by auditing the whole file rather than
the lines that were reported:

  - Adding an API endpoint pointed at backend/api/routes.go; the router
    is backend/internal/cmd/serve/router.go
  - Database changes pointed at database/migrations/; it is
    backend/migrations/, and the step that makes CI pass --
    `just backend migrate-checksums` -- was missing entirely
  - The frontend section described Redux and Storybook. Neither is a
    dependency; the app uses zustand and TanStack Query

Left alone deliberately: "test the migration up and down" reads like the
same rot but is correct -- downs are still written, including for the
four most recent migrations. Checked before editing.

Refs: TRA-1219

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01W7p2hFrE6ZFWS91XvyFQcV
@mikestankavich
mikestankavich deleted the branch chore/tra-1128-align-ignore-block-and-split-process-doc August 31, 2026 11:38
@mikestankavich
mikestankavich deleted the fix/tra-1219-contributing-quickstart-cannot-succeed branch August 31, 2026 11:44
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