chore: symlink CLAUDE.md to AGENTS.md for compatibility - #1420
Conversation
Some agent tooling looks for a CLAUDE.md at the repo root. Add a symlink to the canonical AGENTS.md so both filename conventions resolve to the same instructions, avoiding any duplicated content.
|
commit: |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5164c08fe4
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| @@ -0,0 +1 @@ | |||
| AGENTS.md No newline at end of file | |||
There was a problem hiding this comment.
For Windows or FAT checkouts where Git sets core.symlinks=false, this mode-120000 entry is materialized as a regular file containing only AGENTS.md instead of following the link; Git's core.symlinks docs describe these as "small plain files that contain the link text". In that environment, Claude-style tooling that opens CLAUDE.md will see just the target filename and not the repository instructions, so this compatibility shim fails for those users; use a regular file with a supported include/redirect or another non-symlink mechanism.
Useful? React with 👍 / 👎.
1 participant
What
Add a
CLAUDE.mdsymlink at the repo root pointing to the canonicalAGENTS.md.Why
For compatibility: some agent tooling looks for a
CLAUDE.mdat the repo root, while this repo keeps its instructions inAGENTS.md. The symlink makes both filename conventions resolve to the same content — single source of truth, nothing duplicated to keep in sync.Notes
AGENTS.mdremains the only real file;CLAUDE.mdis just a link (git stores it as mode120000)..gitignore; the local.claudeconvenience link stays ignored as before.