Uh oh!
There was an error while loading. Please reload this page.
Give every fact one home, and stop the README restating values - #18
Merged
Conversation
The README's matching section had drifted into restating docs/matching.md: the five signal weights, the score cap, the auto-merge threshold, and the two algorithm names all appeared in both. Changing a single weight meant editing three files — FuzzyMatcher, matching.md, and a README paragraph nobody would remember to look at. So the README now carries the shape and drops every value. It keeps the three layers, the blocking-finds/scoring-grades distinction, and the property worth knowing before anything else — that automatic fuzzy merging ships off — and says plainly that docs/matching.md is the single place the values are defined. A weight change now touches the code and the doc, and the doc is versioned per matcher so that change is an append. CLAUDE.md gains the rule that would have prevented it. Not "don't duplicate", which is too vague to act on, but an ownership table naming the one file that owns each kind of fact, plus a test to apply before writing a number into prose: if this changes, how many files must I touch? More than one, link instead. Two more rules go in because both already bit us: specs are frozen at merge — slice 3 amended R4-1 in roadmap-notes rather than rewriting slice 2's spec, and that practice was never written down — and a second repository links rather than restates, after the org profile drifted to "Core in development" while two slices had shipped. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Uh oh!
There was an error while loading. Please reload this page.
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 freeto 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.
Spotted while reading the two side by side: the README's How matching decides section had drifted into restating
docs/matching.md. The five signal weights, the score cap, the auto-merge threshold, and both algorithm names appeared in both files.Changing one weight meant editing three places —
FuzzyMatcher,matching.md, and a README paragraph nobody would think to check.What changed
README keeps the shape, drops every value. It still carries the three confidence layers, the blocking-finds / scoring-grades distinction, and the property worth knowing before anything else — that automatic fuzzy merging ships off. It now says plainly that
docs/matching.mdis the single place those values are defined.A weight change now touches two files, and the doc is versioned per matcher version, so that change is an append rather than an edit.
CLAUDE.md gains the rule that would have prevented it. Not "don't duplicate" — too vague to act on — but:
matching.md/ specs /roadmap-notes.md/ contracts / README)Plus two rules that already bit us:
roadmap-notes.mdrather than rewriting slice 2's spec. That was already the practice; it was never written down.Documentation only — no code, no test changes.
🤖 Generated with Claude Code