Skip to content

Replace CLAUDE.md with AGENTS.md - #702

Open
shikokuchuo wants to merge 2 commits into
mainfrom
claude-md-to-agents-md
Open

shikokuchuo wants to merge 2 commits into
mainfrom
claude-md-to-agents-md

Conversation

@shikokuchuo

Copy link
Copy Markdown
Member

Summary

  • Move the project instructions from CLAUDE.md to AGENTS.md. Claude Code reads AGENTS.md, the same as other agents.
  • Rename the per-crate instruction files (pampa, wasm-qmd-parser, wasm-quarto-hub-client) to AGENTS.md.
  • Update all references in comments, skills, and notes.

No code changes. Comment and documentation text only.

Test plan

  • cargo build --workspace and cargo xtask lint pass.
  • A repo-wide search confirms that no stale CLAUDE.md references remain. Two groups of references stay on purpose: the filename detection in project/discovery.rs (user projects can still use CLAUDE.md), and historical notes in claude-notes/.

Claude Code now reads AGENTS.md like other agents, so the instructions
content moves from CLAUDE.md into AGENTS.md (previously a shim that
included CLAUDE.md) and CLAUDE.md is deleted.

Also sweeps stale "see CLAUDE.md" references in 27 files (crate doc
comments, READMEs, .claude skills and rules, the nightly workflow
comment, .beads/.braid READMEs) to point at AGENTS.md, and rewords the
pointer in CONTRIBUTING.md.

Intentionally untouched:
- project/discovery.rs: agent-instruction filename patterns and tests;
  CLAUDE.md remains a valid filename in user projects
- references to per-crate CLAUDE.md files (pampa, wasm-qmd-parser,
  wasm-quarto-hub-client), which still exist
- historical claude-notes/ documents and the cargo-upgrade worktree

Comment/doc-only changes; verified by grep sweep, no code changes.
Renames crates/{pampa,wasm-qmd-parser,wasm-quarto-hub-client}/CLAUDE.md
to AGENTS.md (content unchanged) and updates all path references to
them across crate doc comments, .claude skills, the root AGENTS.md,
and claude-notes working docs (plans, triage docs, instructions,
research). Claude Code reads AGENTS.md like other agents, so this
completes the migration for all current work.

Left in place:
- project/discovery.rs filename patterns and tests: CLAUDE.md remains
  a valid agent-instruction filename in user projects
- root CLAUDE.local.md: gitignored personal overrides, still read by
  Claude Code
- narrative references to the old root CLAUDE.md in historical
  claude-notes documents (records of work done under the old name)

Three file renames plus comment/doc-only path updates; no code changes.
@posit-snyk-bot

posit-snyk-bot commented Sep 21, 2026

Copy link
Copy Markdown
Contributor

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@cderv

cderv commented Sep 21, 2026

Copy link
Copy Markdown
Member

Which is the minimum claude code version for this ? So we're sure it works for us too :)

@shikokuchuo

Copy link
Copy Markdown
Member Author

v2.1.277 - we're already on v2.1.278.

@cscheid

cscheid commented Sep 21, 2026

Copy link
Copy Markdown
Member

This is good but it changes all of our ongoing agent sessions, etc, so let's warn everyone about it on Wednesday and come up with a time to do it.

This branch has not been deployed

No deployments
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.

4 participants