Repository navigation
docs: make the contributor quickstart actually run - #622
Closed
mikestankavich wants to merge 1 commit into
Closed
mikestankavich wants to merge 1 commit into
mikestankavich wants to merge 1 commit into
Conversation
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
deleted the branch
chore/tra-1128-align-ignore-block-and-split-process-doc
August 31, 2026 11:38
mikestankavich
deleted the
fix/tra-1219-contributing-quickstart-cannot-succeed
branch
August 31, 2026 11:44
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Every command in the getting-started path was dead. A stranger following
CONTRIBUTING.mdfailed at step 4 and never reached step 5. These are public repos, so that path is the first thing an outside contributor touches.What was broken
The Quick Setup described an architecture the repo left behind — raw
docker-composeplusgo run cmd/migrate/main.go, predatingjust,direnvand the bootstrap step. Each of these was checked against the tree rather than assumed:cp backend/.env.example backend/.envcp frontend/.env.example frontend/.envgo run cmd/migrate/main.go upjustgo test ./tests/integration -tags=integrationgo run cmd/server/main.gobackend/main.gocd tests/api && pnpm testtests/directory at alljustwas not listed as a required tool, despite being the entry point for every workflow in the repo. Neither wasdirenv.pnpmappeared only as "Node.js 18+", though the repo uses pnpm exclusively and pinspnpm@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, includingjust backend test-integrationandjust 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:
backend/api/routes.go. The router isbackend/internal/cmd/serve/router.go.database/migrations/; it isbackend/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.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 0justrecipe named was confirmed present injust --listWhat 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