chore(repo): remove auto-generated AGENTS.md and CLAUDE.md from git tracking#145
Merged
Merged
Conversation
…racking Both files are generated by `brain docs` from a template in init.rs and were always meant to be per-machine references for AI agents reading the repo. They were previously committed (and force-added on every commit by the pre-commit hook) which had two costs: - every commit produced a noisy "Updated brain section in AGENTS.md" diff that polluted PR signal-to-noise - the committed files drifted from the template anytime a contributor's brain binary was stale, leading to confusing diffs This change: - Removes both files from the git index (`git rm --cached`) but keeps them on disk for the user's current checkout. - Adds CLAUDE.md to .gitignore (AGENTS.md was already there but tracked because it predated the entry — `git rm --cached` was needed to actually stop tracking it). - Updates `scripts/pre-commit` and `hooks/pre-commit` to drop the `git add -f AGENTS.md` line. The regeneration step stays so the local copy is kept fresh for AI agents; we just no longer force the file into the commit. After this change, a contributor cloning fresh runs `cargo install --path crates/cli` (or `just install`) and then `brain docs` to regenerate the two files locally. They're never committed again. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…d/CLAUDE.md Adds a brief note in the "From source" subsection of Installation explaining that AGENTS.md and CLAUDE.md are not committed and need to be generated locally via `just docs`. Closes the workflow gap a multi-lens review of this PR flagged: fresh-clone contributors had no documented path to the docs that the project's own CLAUDE.md historically pointed at. Verified locally: `brain docs` regenerates both files cleanly on a fresh checkout of this branch (`Generated AGENTS.md` / `Generated CLAUDE.md (bridge to AGENTS.md)`). Also confirmed during this work: - `just install-hooks` already exists and sets `core.hooksPath = hooks/`, so the "stale local hook" concern from review is mitigated by existing infrastructure (anyone who runs `just install` is on the versioned hooks directory). - The existing user-content fence in `upsert_agent_docs` preserves anything outside the `<!-- brain:start -->...<!-- brain:end -->` markers, so user additions to CLAUDE.md (like graphify integration blocks) survive regeneration. - Sub-directory AGENTS.md files (`.github/`, `tests/`, etc.) are not tracked by git and never were — the depth-matching gitignore pattern catches them by design. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.
Summary
Stops committing
AGENTS.mdandCLAUDE.md— they're per-machine references generated bybrain docsfrom a template ininit.rs. They were being force-added by the pre-commit hook on every commit, producing noisy "Updated brain section in AGENTS.md" diffs that polluted PR signal.What changed
git rm --cached AGENTS.md CLAUDE.md— removes from the index, keeps the files on disk locally.gitignore— addsCLAUDE.md(AGENTS.md was already listed but still tracked because it predated the entry)scripts/pre-commitandhooks/pre-commit— drop thegit add -f AGENTS.mdline. The regeneration step stays so the local copy is kept fresh for AI agents reading the repo; we just no longer force-stage itCLAUDE.md(implicitly, sincebrain docsalready produces both)Contributor flow after this lands
AGENTS.mdorCLAUDE.mdin the working tree)just install(orcargo install --path crates/cli)brain docs— regenerates both files locallyA documentation update to call this out in the README's contributor section will land separately as part of the broader docs sweep.
Test plan
brain docson a fresh checkout and verify both files are generatedgit commitdoes NOT include either file in the commit diff🤖 Generated with Claude Code