Trim CONTRIBUTING.md to a stub; move dev gotchas into CLAUDE.md - #618
Merged
Merged
Conversation
The old guide described conventions the repo doesn't follow and a stack it no longer has: - It routed backend reviews to "someone who works with Python/FastAPI". There is no FastAPI here; backend/ is TypeScript/Hono. - It mandated feat//fix//chore/ branches and `type:` commit subjects. Actual branches are claude/*, ux/*, mindmap-main; actual subjects are plain imperative sentences. Nothing linked to the file, so the stale conventions had no counterweight — anyone who did read it got bad information. Replaced with a short index pointing at the docs that are maintained because they sit next to their code (backend/README.md, frontend/CLAUDE.md, frontend/TESTING.md, VISUAL_REGRESSION.md, docs/). Keeps the two genuinely non-obvious gotchas: CI-only Playwright baselines, and the pre-push hook that typechecks experiment/ on main pushes. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01EVaiHqHvxameg9j8JPRWBC
The pointer index still restated root CLAUDE.md: same two-app orientation, same Issues/backlog note. Half of it was duplication, and the half that wasn't sat in a file nothing auto-loads. So put each note where it fires: - frontend/CLAUDE.md said "Run with `npx playwright test`" and nothing about baselines. Added the CI-only regeneration note right there. - The pre-push hook was documented in no CLAUDE.md at all; noted in the root Workflow section. CONTRIBUTING.md drops to a 15-line stub: what the repo is, where conventions actually live, and the PR norms. It exists for GitHub's Contribute UI, so it points rather than repeats. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01EVaiHqHvxameg9j8JPRWBC
kcarnold
changed the title
The hook is being removed in favor of a CI typecheck for experiment/, so documenting it here would land a note about a hook that no longer exists. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01EVaiHqHvxameg9j8JPRWBC
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
2 participants
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.
CONTRIBUTING.md goes from 259 lines to 15, and the note worth keeping moves into the file that gets auto-loaded.
Why
The old guide described conventions the repo doesn't follow and a stack it no longer has. Nothing linked to it, so the stale parts had no counterweight:
grep -rn fastapireturns nothing repo-wide;backend/is TypeScript/Hono, and rootpyproject.tomlsays the remaining Python supportsscripts/analysis tooling only.feat/,fix/,test/,chore/. Recent merges areclaude/*,ux/*,mindmap-main, plus dependabot.type: description. Actual subjects are plain imperative sentences; the only reliabletype:prefixes come from dependabot.A first pass replaced it with a ~50-line pointer index, but that still restated root CLAUDE.md — same two-app orientation, same Issues/
backlognote. Roughly half was duplication, and the half that wasn't sat in a file nothing auto-loads.What changed
frontend/CLAUDE.mddocumented Playwright as "Run withnpx playwright test" and said nothing about baselines. The CI-only regeneration note is now attached to that line, where it's in front of you at the moment it matters.CONTRIBUTING.md is a 15-line stub: what the repo is, where conventions actually live (
CLAUDE.md, the per-directory files,docs/), and the PR norms. It exists to fill GitHub's Contribute UI, so it points rather than repeats.Two files changed, +16/−246.
Testing
backend/README.mdand the rootDockerfile; the baseline flow againstVISUAL_REGRESSION.mdand.github/workflows/frontend-tests.yml.Follow-up, not in this PR
Root
README.mdpoints atfrontend/README.md, which doesn't exist (the frontend hasCLAUDE.mdandTESTING.md). The stub routes around it rather than reproducing the dead link. Happy to fix it here or separately.Related
#619 adds the missing PR-time typecheck for
experiment/and removes the Huskypre-pushhook. An earlier revision of this PR documented that hook in root CLAUDE.md; that line has been dropped, since #619 deletes the hook it described. The two PRs are independent and can merge in either order.