chore: keep agent guidance local instead of tracking AGENTS.md - #34
Merged
Merged
Conversation
CLAUDE.md was already gitignored while AGENTS.md was tracked, so the two drifted: the local copy carried our deploy procedure and environment notes and the committed one did not. Keeping them in sync by hand kept losing, and the local edits ended up living in a git stash across branch switches. This fork's GitHub repository is public, and the notes that matter here are our own infrastructure -- the prod host, its paths, the deploy sequence, an internal document URL. That is guidance for whoever works on this checkout, not content for a public repo, so both files are now ignored. They are now literally the same file: AGENTS.md holds the content and CLAUDE.md is a symlink to it, which is the only arrangement that actually guarantees the "always identical" part rather than hoping someone remembers. Two consequences worth knowing: - AGENTS.md is maintained upstream (makeplane/plane has it; the commits touching it in our history are all upstream PRs). A future merge that changes it will want to reintroduce the file and will need resolving in favour of ignoring it again. Reverting this commit is the escape hatch if that becomes tiresome. - Because the path is now ignored, pulling this commit deletes the working-tree AGENTS.md for anyone who has one. Copy it somewhere first if it has local notes worth keeping. Nothing in the repo or CI references AGENTS.md, so nothing else breaks. Co-Authored-By: Claude Opus 5 <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.
Description
CLAUDE.mdwas already gitignored whileAGENTS.mdwas tracked, so the two drifted: the local copy carried our deploy procedure and environment notes and the committed one did not. Keeping them in sync by hand kept losing — the local edits had ended up living in agit stashacross branch switches.This fork's GitHub repository is public, and the notes that matter here are our own infrastructure: the prod host and its paths, the deploy sequence, an internal document URL. That is guidance for whoever works on this checkout, not content for a public repo. So both files are now ignored.
They are now literally the same file:
AGENTS.mdholds the content andCLAUDE.mdis a symlink to it. That is the only arrangement that actually guarantees the "always identical" part, rather than relying on someone remembering to copy changes across.Type of Change
Test Scenarios
git check-ignore -vconfirms bothAGENTS.mdandCLAUDE.mdresolve to the new ignore rules.diff AGENTS.md CLAUDE.mdis empty — they are the same inode via the symlink.AGENTS.md, so no tooling or CI breaks.8002port note included).References
Two consequences worth knowing before merging:
AGENTS.mdis maintained upstream.makeplane/planehas it, and every commit touching it in our history is an upstream PR (makeplane#9138, makeplane#8677, makeplane#8220). A future merge from upstream that changes the file will want to reintroduce it and will need resolving in favour of ignoring it again. Reverting this commit is the escape hatch if that becomes tiresome.AGENTS.mdfor anyone who has one, because the path is now ignored. Tell the team to copy theirs somewhere first if it has local notes worth keeping.