Skip to content

CLAUDE.md is a symlink to AGENTS.md - #43

Merged
rjrodger merged 1 commit into
mainfrom
docs/claude-agents-symlink
Sep 17, 2026
Merged

rjrodger merged 1 commit into
mainfrom
docs/claude-agents-symlink

Conversation

@rjrodger

Copy link
Copy Markdown
Contributor

One guide, reachable under both names. Claude Code looks for CLAUDE.md and most other agents look for AGENTS.md; a repository that answers only one either loses half its readers or keeps two files that drift.

A symlink rather than a copy or a stub: git stores it as a link (mode 120000), so there is exactly one file to edit and no second copy to forget.

The content was checked before it went, not assumed — see the commit message for what this repo's CLAUDE.md held, what was already covered in AGENTS.md, and anything rescued into it.

🤖 Generated with Claude Code

https://claude.ai/code/session_019wTUyjnYpUkD9xPu15AKbR

One guide, reachable under both names. Claude Code looks for CLAUDE.md and
most other agents look for AGENTS.md, and a repository that answers only
one of them either loses half its readers or keeps two files that drift.

THE CONTENT WAS CHECKED BEFORE IT WENT, not assumed. The CLAUDE.md here
was a pointer at AGENTS.md followed by condensed reminders, and every one
of them was already in AGENTS.md at greater length: the canonical-port
rule, the corpus-is-the-contract rule, the parity check, the no-runtime-
dependencies rule, the build commands and the prose gate. Nothing needed
rescuing, so nothing was moved.

A symlink, not a copy: git stores it as a link (mode 120000), so there is
one file to edit and no second copy to drift.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019wTUyjnYpUkD9xPu15AKbR
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 17, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-17T15:33:59.533607Z 7d385ef PR opened
ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector

Copy link
Copy Markdown

💡 Codex Review

AGENTS.md

P2 Badge Preserve guidance when Git cannot create symlinks

On checkouts with core.symlinks=false, which is common on Windows and filesystems without symlink support, Git writes this as a regular file whose entire contents are only AGENTS.md (Git documentation: “symbolic links are checked out as small plain files that contain the link text”). Claude Code then receives a filename rather than the mandatory guide, while the previous stub explicitly directed it to read that guide; keep a regular CLAUDE.md that imports or references AGENTS.md so these checkouts still load the instructions.

AGENTS.md reference: AGENTS.md:L3-L5

ℹ️ 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".

@rjrodger
rjrodger merged commit 8b5af6b into main Sep 17, 2026
28 checks passed
@rjrodger
rjrodger deleted the docs/claude-agents-symlink branch September 17, 2026 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant