Skip to content

Rename CLAUDE.md to AGENTS.md - #86

Merged
marknolan merged 1 commit into
mainfrom
chore/agents-md
Sep 15, 2026
Merged

marknolan merged 1 commit into
mainfrom
chore/agents-md

Conversation

@marknolan

Copy link
Copy Markdown
Member

Moves this repo's agent instructions to AGENTS.md, the vendor-neutral convention, and leaves a
one-line CLAUDE.md that imports it.

Why bother. AGENTS.md is an open spec — formalised in August 2025 and now stewarded by the
Linux Foundation's Agentic AI Foundation — read directly by Cursor, Copilot, Codex and around twenty
other tools. Our content was already tool-neutral (build commands, constraints, gotchas), so this is
a rename, not a rewrite. Nothing about what the file says has changed.

Why the bridge file. Claude Code reads CLAUDE.md and not AGENTS.md
(docs), so CLAUDE.md is now just @AGENTS.md plus a
maintainer comment. The comment is an HTML block comment, which Claude Code strips before loading, so
it costs nothing in context but explains the arrangement to whoever opens the file next.

A symlink is the documented alternative and would be tidier — but creating one on Windows requires
Administrator privileges or Developer Mode, so the import is the portable choice for this team.

If you adopt another agent later, it reads AGENTS.md with no further work, and there is only
one file to keep current.

🤖 Generated with Claude Code

AGENTS.md is the vendor-neutral convention for agent instructions — an open
spec stewarded by the Linux Foundation's Agentic AI Foundation, read directly
by Cursor, Copilot, Codex and others. The content here was already tool-neutral,
so the rename costs nothing and keeps the file useful if anyone adopts a
different agent.

Claude Code reads CLAUDE.md rather than AGENTS.md, so a one-line CLAUDE.md
imports it. A symlink is the documented alternative but needs Administrator
privileges or Developer Mode on Windows, which rules it out for this team.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Claude Code Review

This repository is configured for manual code reviews. Comment @claude review for a one-time review, or @claude review always to subscribe this PR to a review on every future push.

Tip: disable this comment in your organization's Code Review settings.

@marknolan
marknolan merged commit e5c25de into main Sep 15, 2026
3 checks passed
@marknolan
marknolan deleted the chore/agents-md branch September 15, 2026 12:05
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