docs: link CLAUDE.md to AGENTS.md - #957
Merged
Merged
Conversation
manuzhang
force-pushed
the
agent/link-claude-md
branch
from
September 23, 2026 02:08
40c0114 to
b9b7be2
Compare
Claude Code reads CLAUDE.md, so it did not pick up the shared agent instructions in AGENTS.md. Check in CLAUDE.md as a symlink to AGENTS.md. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
manuzhang
force-pushed
the
agent/link-claude-md
branch
from
September 23, 2026 02:12
b9b7be2 to
e98d18f
Compare
Collaborator
|
I think Claude Code reads agents.md, https://github.com/anthropics/claude-code/tree/main/mods/agents-md |
Member
Author
Okay, let me check again. It ignored instructions in the |
wgtmac
approved these changes
Sep 23, 2026
wgtmac
left a comment
wgtmac
left a comment
Member
There was a problem hiding this comment.
It doesn't hurt to add this even if claude has said to respect AGENTS.md.
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.
What
Check in
CLAUDE.mdas a symlink toAGENTS.md.Why
Claude Code reads
CLAUDE.md, notAGENTS.md, so it never picked up theagent instructions this repository already maintains. The symlink keeps
AGENTS.mdthe single source of truth instead of duplicating its contents.Behavior change
CLAUDE.mdis now tracked, so it is no longer available for personal,unshared instructions. Contributors who already have an untracked
CLAUDE.mdneed to move it aside before pulling, since git will notoverwrite it. On checkouts without symlink support (Windows with
core.symlinks=false),CLAUDE.mdmaterializes as a text file containingthe path
AGENTS.md.Testing
Confirmed the file is committed with symlink mode
120000and that readingCLAUDE.mdin a fresh checkout yields the contents ofAGENTS.md.🤖 Generated with Claude Code