Make AGENTS.md the source of truth with CLAUDE.md as a symlink#923
Open
billadunblock wants to merge 1 commit into
Open
Make AGENTS.md the source of truth with CLAUDE.md as a symlink#923billadunblock wants to merge 1 commit into
billadunblock wants to merge 1 commit into
Conversation
AGENTS.md is the industry-adopted convention for AI coding agent instructions, so the full guide now lives there. CLAUDE.md becomes a symlink to AGENTS.md so Claude Code keeps resolving it by name, and the previous fallback-summary stub is no longer needed. References in the PR template, onboarding docs, and agent definitions now point at AGENTS.md. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Author
|
@jevansnyc as we expand agent harnesses and enrich agentic workflows, this change can be pretty handy (prioritize AGENT.md wth CLAUDE.md as symlink). Consider for corporate users, they can only use Claude Code Enterprise plan (data not for training) which is not very practical for the token price, multi harnesses would be ideal in lots of cases. |
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
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
AGENTS.mdthe single source of truth for AI coding agent instructions, replacingCLAUDE.mdwith a symlink to it —AGENTS.mdis the tool-agnostic industry convention (used by Codex, Cursor, and others; see agents.md), while the symlink keeps Claude Code working by its conventional filename with zero duplication or drift.AGENTS.mdredirect stub and its fallback summary, so there is only one copy of the rules.AGENTS.md.Changes
AGENTS.mdCLAUDE.mdviagit mv, sogit log --followpreserves history); redirect stub removedCLAUDE.mdAGENTS.md(mode120000).github/pull_request_template.mdAGENTS.mddocs/guide/onboarding.mdAGENTS.md.claude/agents/code-simplifier.mdAGENTS.md.claude/agents/pr-reviewer.mdAGENTS.md.claude/commands/review-changes.mdAGENTS.mdCloses
N/A — issues are disabled on this repository.
Test plan
cd docs && npm run formathead CLAUDE.mdresolves through the symlink to theAGENTS.mdcontent;git log --follow AGENTS.mdshows the preserved historyNo Rust or JS code is touched, so the cargo and vitest gates don't apply to this change.
Checklist
unwrap()in production code — useexpect("should ...")(no Rust changes)tracingmacros (notprintln!) (no Rust changes)Notes
core.symlinks=falseunless symlink support is available (Windows Developer Mode enabled, or an elevated shell). With symlinks disabled, git checks outCLAUDE.mdas a plain one-line text file containing the pathAGENTS.mdinstead of a real symlink, so tools that readCLAUDE.mdwould see the pointer text rather than the instructions. To get a real symlink: enable Developer Mode (Settings → System → For developers), then clone withgit clone -c core.symlinks=true, or in an existing clone rungit config core.symlinks truefollowed bygit checkout -f CLAUDE.mdto re-materialize it.References
CLAUDE.mdfrom the project root, which the symlink satisfies while keepingAGENTS.mdas the single source.