docs: self-contained-committed-content guardrail in CLAUDE.md (part of JEF-632) - #301
Merged
Merged
Conversation
…f JEF-632) Adds the convention that committed repo content (ADRs, source comments, CLAUDE.md, VISION.md, scripts, chart templates) cites in-repo material — an ADR, a file/module path, VISION.md, or inline reasoning — never a Linear ticket ID or linear.app URL, with the integration-mechanics boundary (branch names, PR Closes-keyword, the tickets themselves, git history) called out. Also fixes one dangling ref (the north-star note now cites VISION.md's 'Honest current state' instead of a ticket id). This lands JEF-632's durable, forward-looking half (the guardrail that stops NEW refs); the historical source/ADR comment sweep remains open under JEF-632 (its WIP branch went stale against the #300 journal split — better re-done fresh off main). Co-Authored-By: Claude Opus 4.8 <[email protected]> Claude-Session: https://claude.ai/code/session_01VtjoJttCvBY4dzCoE4f9vP
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.
Lands the durable, forward-looking half of JEF-632: the CLAUDE.md convention that committed repo content stays self-contained (cite in-repo ADRs/files/VISION.md, never
JEF-nnn/linear.app), with the integration-mechanics boundary (branch names, theCloses JEF-nnnkeyword, Linear tickets, git history) explicitly carved out so it isn't over-read. Also fixes one dangling north-star ref.Docs-only — no code, no clippy/test/security surface.
The historical source/ADR comment sweep (JEF-632's other half) stays open: its swarm attempt stalled twice and its WIP branch went stale against the #300 journal split, so it's best re-done fresh off main — now guarded against regression by this convention. Does not close JEF-632.