Rename AGENT.md to AGENTS.md, add CLAUDE.md symlink#223
Open
njbrake wants to merge 1 commit into
Open
Conversation
Aligns with the agents.md cross-tool convention so coding-assistant tools pick up project guidance automatically. CLAUDE.md is a symlink to AGENTS.md for Claude Code, which looks for that specific filename.
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.
Note: this PR was drafted by Claude via back-and-forth with @njbrake. The reasoning and decisions are his; the prose is Claude's.
Summary
AGENT.mdtoAGENTS.md, matching the agents.md cross-tool convention adopted by OpenAI Codex, Cursor, Aider, and others.CLAUDE.mdas a symlink toAGENTS.mdso Claude Code picks up the same instructions without duplicating content.Why
AGENTS.md(plural) is the filename most coding-assistant tools now look for by default. Standardising on it means any agent run in this repo, not only one specific vendor's, finds the project's guidance file automatically. TheCLAUDE.mdsymlink covers Claude Code, which still looks for that specific filename.If you'd rather not carry the vendor-specific symlink upstream, happy to drop it and keep the rename only.