docs: trim CLAUDE.md to non-inferable rules#562
Open
kylehoehns wants to merge 1 commit into
Open
Conversation
Replace the README-style architecture overview (model/service/cron lists, verbatim tsconfig path aliases, commit conventions duplicated from README) with only non-inferable, currently-true guidance: the pnpm verify gate, the timezone-sensitive test gotcha, and a pointer to README for commit/PR conventions. Went from ~135 lines of mostly overview to ~20 lines of rules.
kylehoehns
force-pushed
the
docs/trim-claude-md
branch
from
97084a8 to
e40afe4
Compare
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.
What
Rewrites
CLAUDE.mdfrom a README-style architecture tour into a lean set of agent rules. Went from ~135 lines (mostly overview) to ~20 lines.Why
CLAUDE.mdis loaded into an agent's context every session. Content that merely re-describes what's already in the repo adds cost without helping — the agent readssrc/,tsconfig.json, andjest.config.json its own. Worse, copied content (like the path aliases) goes stale silently and the agent trusts the doc over the code.What was cut (all inferable from the repo)
src/)tsconfig.json)jest.config.js)What was kept (non-inferable, true today)
pnpm verifyis the required gate before a task is donejestdirectly dropsTZ=America/Chicagoand breaks date logic; usepnpm test -- <pattern>🤖 Generated with Claude Code