Skip to content

Make AGENTS.md the single source of truth - #9

Merged
omarshahine merged 1 commit into
mainfrom
omarshahine/agents-md-canonical
Sep 20, 2026
Merged

omarshahine merged 1 commit into
mainfrom
omarshahine/agents-md-canonical

Conversation

@omarshahine

Copy link
Copy Markdown
Owner

Claude Code reads AGENTS.md as the project instructions when there is no CLAUDE.md in the working directory or above it. That is the default (claude-md-or-agents-md) and needs Claude Code 2.1.277 or later; this machine is on 2.1.278. So the CLAUDE.md compatibility shim has no job left, and AGENTS.md becomes the single source of truth.

Nothing about the instructions themselves changes. Where CLAUDE.md was a symlink to AGENTS.md it is simply removed; where the symlink pointed the other way, the real file is moved to AGENTS.md.

Live pointers to the removed file are updated in the same commit. Historical mentions in WORKLOG, changelogs and memory notes are left alone, since those are records of what happened.

🤖 Generated with Claude Code

Claude Code reads AGENTS.md as the project instructions when no CLAUDE.md
exists in the working directory or above it (default claude-md-or-agents-md,
Claude Code 2.1.277+). The CLAUDE.md compatibility shim is no longer needed,
so AGENTS.md becomes the single source of truth.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@greptile-apps

greptile-apps Bot commented Sep 20, 2026

Copy link
Copy Markdown

RetriggerConfidence Score: 5/5

The PR appears safe to merge; all changed references resolve correctly and no actionable regression was identified.

Summary

This PR makes AGENTS.md the sole project-instructions file by removing the obsolete CLAUDE.md symlink and updating live references.

  • README contributor documentation now links directly to AGENTS.md.
  • The release script’s Icon Composer comment now points to the corresponding AGENTS.md guidance.
  • Historical references remain unchanged as intended.

Reviews (1) · Last reviewed commit: "Make AGENTS.md the single source of trut..."

@omarshahine
omarshahine merged commit b7971be into main Sep 20, 2026
2 checks passed
@omarshahine
omarshahine deleted the omarshahine/agents-md-canonical branch September 20, 2026 17:04
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