claude.md: record the conventions and the traps worth knowing - #11
Merged
Conversation
The commit shape, the fix-up-before-merge rule, and the four traps that have each cost a day. Also brings the cross-check target list and the clippy/fmt gates in line with what ci.yml actually runs.
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
1 participant
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.
Writes down two things that were only in people's heads.
Commits and history — the commit shape (
scope: imperative description, where thescope is where the change lives, not what kind of change it is), one logical change per
commit, fold fix-ups in before merge, don't squash a feature branch, don't rewrite
published history.
Traps that have already cost a day — the four that keep recurring:
grep -c FAILEDmissing a suite that failed to compile (check the test count), CI's clippy being newer
than the local one, the pty capture compositing stale rows, and repeating an unverified
claim. Plus the corpus checks (
TREAD_*_CORPUS) that are in the suite but skipped unlesspointed at real code, and what each of them has caught.
Also brings three stale statements in line with what
ci.ymlactually runs:aarch64-pc-windows-msvc(CI has checked itsince the
ci.ymlcommit;README.mdanddocs/windows.mdalready said so)cargo clippy --all-targets -- -D warningsis in the pre-flight list, since CI gates on itcargo fmtis not run on this tree — stated, so it stops being folkloreDocs only; no code touched.
cargo testgreen (1308 + the integration binaries, 0 failed).Pairs with #12 — that branch's CONTRIBUTING.md defers to these two sections
rather than restating them, so the pair cannot drift. Either can merge first.