Skip to content

chore: rename CLAUDE.md to AGENTS.md and symlink#618

Merged
jdx merged 1 commit intomainfrom
chore/claude-md-symlink-agents
May 3, 2026
Merged

chore: rename CLAUDE.md to AGENTS.md and symlink#618
jdx merged 1 commit intomainfrom
chore/claude-md-symlink-agents

Conversation

@jdx
Copy link
Copy Markdown
Owner

@jdx jdx commented May 3, 2026

Summary

  • Renames CLAUDE.md to AGENTS.md so the project instructions live under the standard agents file
  • Replaces CLAUDE.md with a symlink to AGENTS.md so Claude Code keeps loading the same content

Test plan

  • readlink CLAUDE.md resolves to AGENTS.md
  • Claude Code in this repo still picks up the project instructions

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only change that renames the agent instructions file and introduces a CLAUDE.md symlink; no runtime code paths are affected, with minimal risk aside from tooling that doesn’t follow symlinks.

Overview
Moves the Claude Code repository instructions from CLAUDE.md to a new AGENTS.md (same content) to match the standard agents filename.

Replaces CLAUDE.md with a symlink-style stub pointing at AGENTS.md so existing tooling that reads CLAUDE.md continues to work.

Reviewed by Cursor Bugbot for commit fb6d811. Bugbot is set up for automated code reviews on this repo. Configure here.

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

greptile-apps Bot commented May 3, 2026

Greptile Summary

This PR renames CLAUDE.md to AGENTS.md (the emerging standard name for AI agent instructions) and replaces CLAUDE.md with a relative symlink so Claude Code continues to find the same content. The change is straightforward with no functional impact; the only cosmetic issue is that the # CLAUDE.md heading inside AGENTS.md was not updated to match the new filename.

Confidence Score: 5/5

Safe to merge — pure documentation rename with a correct symlink; no logic changes.

Only finding is a P2 stale heading inside the markdown file; no code, tests, or build files are affected.

AGENTS.md — update the # CLAUDE.md heading to # AGENTS.md

Important Files Changed

Filename Overview
AGENTS.md New canonical project-instructions file; content is identical to the old CLAUDE.md except the heading still reads "# CLAUDE.md"
CLAUDE.md Replaced with a relative symlink pointing to AGENTS.md (mode 120000); symlink target is correct

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Claude Code / Codex / other agents] -->|reads| B[CLAUDE.md symlink]
    B -->|resolves to| C[AGENTS.md]
    A -->|reads directly| C
Loading

Fix All in Claude Code

Reviews (1): Last reviewed commit: "chore: rename CLAUDE.md to AGENTS.md and..." | Re-trigger Greptile

Comment thread AGENTS.md
@@ -0,0 +1,162 @@
# CLAUDE.md
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Stale heading after rename

The file was renamed to AGENTS.md but the top-level heading still reads # CLAUDE.md. This is a cosmetic inconsistency — tools or readers that use the heading as a display name will still show the old name.

Suggested change
# CLAUDE.md
# AGENTS.md

Fix in Claude Code

@codecov
Copy link
Copy Markdown

codecov Bot commented May 3, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.03%. Comparing base (9213dfe) to head (fb6d811).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #618   +/-   ##
=======================================
  Coverage   79.03%   79.03%           
=======================================
  Files          48       48           
  Lines        7235     7235           
  Branches     7235     7235           
=======================================
  Hits         5718     5718           
  Misses       1140     1140           
  Partials      377      377           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@jdx jdx merged commit f9ea78b into main May 3, 2026
12 checks passed
@jdx jdx deleted the chore/claude-md-symlink-agents branch May 3, 2026 12:18
@mise-en-dev mise-en-dev mentioned this pull request May 3, 2026
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request renames the AI guidance documentation from CLAUDE.md to AGENTS.md. The review feedback identifies an inconsistency where the header inside the new AGENTS.md file still references the old filename and suggests a correction.

Comment thread AGENTS.md
@@ -0,0 +1,162 @@
# CLAUDE.md
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The header in this file should be updated to match the new filename AGENTS.md for consistency.

Suggested change
# CLAUDE.md
# AGENTS.md

jdx pushed a commit that referenced this pull request May 3, 2026
### 🚀 Features

- **(complete)** auto-completion for usage shebang scripts by
[@jdx](https://github.com/jdx) in
[#620](#620)

### 🐛 Bug Fixes

- **(docs)** stack banner and pin close button on mobile by
[@jdx](https://github.com/jdx) in
[#603](#603)

### 📚 Documentation

- **(site)** show release version and github stars by
[@jdx](https://github.com/jdx) in
[#604](#604)
- add cross-site announcement banner by [@jdx](https://github.com/jdx)
in [#600](#600)
- fix banner dark-mode contrast by [@jdx](https://github.com/jdx) in
[#601](#601)
- respect banner expires field by [@jdx](https://github.com/jdx) in
[#602](#602)
- prefix star count with ★ glyph and populate it on deploy by
[@jdx](https://github.com/jdx) in
[#606](#606)
- integrate Commander.js, oclif and yargs by
[@gaojunran](https://github.com/gaojunran) in
[#616](#616)
- integrate Typer and Click by
[@gaojunran](https://github.com/gaojunran) in
[#619](#619)

### 🔍 Other Changes

- **(docs)** remove shrill.en.dev analytics script by
[@jdx](https://github.com/jdx) in
[#614](#614)
- **(release)** append en.dev sponsor blurb to release notes by
[@jdx](https://github.com/jdx) in
[#598](#598)
- switch analytics from gtm to plausible by
[@jdx](https://github.com/jdx) in
[#609](#609)
- pin taiki-e/install-action to commit SHA by
[@jdx](https://github.com/jdx) in
[#610](#610)
- rename CLAUDE.md to AGENTS.md and symlink by
[@jdx](https://github.com/jdx) in
[#618](#618)

### 📦️ Dependency Updates

- bump communique to 1.1.2 by [@jdx](https://github.com/jdx) in
[#605](#605)
- lock file maintenance by
[@renovate[bot]](https://github.com/renovate[bot]) in
[#607](#607)
- update autofix-ci/action action to v1.3.4 by
[@renovate[bot]](https://github.com/renovate[bot]) in
[#611](#611)
- update apple-actions/import-codesign-certs action to v7 by
[@renovate[bot]](https://github.com/renovate[bot]) in
[#612](#612)
- update taiki-e/install-action digest to fc9eae0 by
[@renovate[bot]](https://github.com/renovate[bot]) in
[#613](#613)

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
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