chore: stop shipping working material in the repository - #9
Merged
Conversation
CLAUDE.md, codemaps/, .reports/, .vscode/ and a debug-probe test in the metrics module were tracked, so every clone carried notes that describe how the project was built rather than how the library works. CLAUDE.md in particular had grown to 68K of stage history, and it drifted: several claims in it were corrected only after an audit, and one had been wrong since the version it described. Untracked rather than deleted -- the files stay on disk as working notes and as the material the retrospective draws on. Documentation a reader or an agent should rely on lives in docs/. lfu/simplelfu/lfu_test.go cited "CLAUDE.md rule 5" for the no-panic rule; with the file gone from the repository that reference points at nothing, so the comment now states the rule instead of citing it. make all passes, including release-check across all ten modules.
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.
CLAUDE.md,codemaps/,.reports/,.vscode/and a debug-probe test inthe
metricsmodule were tracked, so every clone carried notes describing howthe project was built rather than how the library works.
CLAUDE.mdalone was68K of stage history, and it had drifted -- several of its claims were
corrected only after an audit, and one had been wrong since the version it
described.
They are untracked rather than deleted: the files stay on disk as working
notes and as material for a retrospective write-up. Documentation a reader or
a tool should rely on lives in
docs/.lfu/simplelfu/lfu_test.gocited "CLAUDE.md rule 5" for the no-panic rule.With the file gone from the repository that reference points at nothing, so
the comment states the rule instead of citing it.
Verification
A fresh clone of this branch contains none of the removed paths, and the
metricsmodule still builds and passes its tests without the debug probe:ok github.com/sshaplygin/as-cache/metrics 0.549s.Follow-up, not in this change
The load-bearing invariants that lived in the removed file (the zero-value
rule, the
switchLockedordering rule, the three roles during a gradualmigration window, the bandit running under the write lock, why
TTLCacheisnot built on
expirable) now exist only outside the repository. Folding theminto
docs/is the next documentation change.