Split CLAUDE.md into agent rules and a CONTRIBUTING guide - #42
Open
Travus wants to merge 1 commit into
Open
Conversation
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.
Closes #36.
CLAUDE.md was 663 lines and mixed rules an agent must obey with the arguments behind
them. It is now 441 lines / 3,626 words, down from 663 / 5,967 — about 40% smaller.
Three audiences, three files
next to what it governs.
and the by-hand deb/AppStream verification.
Deleted from CLAUDE.md, already documented next to the code
chords.ts:61-70ShortcutsDialog.tsx:24-30search.ts:1-16ActionPalette.tsx:14-19·meta separatorabilities.ts:15-19Deleted outright: the "cite the book you are most likely to own" convention, which
governs data packs rather than anything shipped from this repo. The rule survives in
abilities.ts, where pack authors writing against this shape will actually see it.Kept as one line each:
Ctrl+Xreserved on macOS, reference lists searching names only,sequences left out of the native accelerator column, presets replacing wholesale.
Refiling
~150 lines of packaging documentation — the portable exe lock, Linux icons, deb
descriptions, AppStream metainfo, macOS cross-build — sat under
### The action palette, a third-level heading inside## Keybindings. It now has its own## Packaging and distributionsection. The panel-clipping rule moved to## Rendering, and search to## Search.The comment pass found little to cut
chords.ts48%,shortcuts.ts40%,search.ts39%,palette.ts35% — essentiallyunchanged. The duplication was real but it was resolved by deleting CLAUDE.md's side;
those comments are now the only copy of that reasoning, and cutting them to hit a
percentage would delete what this PR deliberately preserved. Two genuine edits:
shortcuts.tslost a paragraph of history about a table that no longer exists, andabilities.tslost aSee CLAUDE.mdpointer that this PR made dangle.README fixes that belonged to #35
Found while checking for dangling references — the CI section still documented
package.yml, deleted in #35, and the--audit-level=criticalgate, changed in #35. Mymiss there; corrected here along with a pointer to CONTRIBUTING.md.
Verification
npm run checkclean — format, lint, typecheck, 125 tests. No remaining references topackage.yml,audit-level=critical, or CLAUDE.md sections that no longer exist.