Skip to content

chore: replace root CLAUDE.md with AGENTS.md - #485

Open
jarrensj wants to merge 1 commit into
clerk:mainfrom
jarrensj:remove-claude-md
Open

jarrensj wants to merge 1 commit into
clerk:mainfrom
jarrensj:remove-claude-md

Conversation

@jarrensj

@jarrensj jarrensj commented Sep 18, 2026

Copy link
Copy Markdown

Summary

As of Claude Code v2.1.277, Claude Code reads AGENTS.md directly in a project with no CLAUDE.md, so keeping both is redundant. This makes AGENTS.md the single real instruction file.

Changes:

  • At the repo root, AGENTS.md was a symlink to CLAUDE.md. This renames CLAUDE.md to AGENTS.md as a regular file and removes the symlink. Content is unchanged.
  • Updates the changesets skill (SKILL.md and references/policy.md) so its list of changeset-exempt root docs names AGENTS.md instead of CLAUDE.md.

Left alone on purpose: the CLAUDE.md files under test/e2e/fixtures/* and the comment in scripts/refresh-e2e-fixtures.ts. Those are scaffolder output that simulates user projects, not repo instructions.

Testing

git grep CLAUDE.md returns no matches outside the e2e fixtures and the fixture-refresh script. No package source changes, so no changeset is needed per CONTRIBUTING.md.

Claude Code now reads AGENTS.md directly, so the root AGENTS.md symlink
that pointed at CLAUDE.md was the wrong way round. Renames CLAUDE.md to
AGENTS.md as a regular file and drops the symlink. Content unchanged.
Also updates the changesets skill's list of exempt root docs to name
AGENTS.md instead of CLAUDE.md.
@changeset-bot

changeset-bot Bot commented Sep 18, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: a014798

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Sep 18, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 25c0fc2d-360b-41c2-a46c-901d770ccd5d

📥 Commits

Reviewing files that changed from the base of the PR and between ba5e3c8 and a014798.

📒 Files selected for processing (5)
  • .claude/skills/changesets/SKILL.md
  • .claude/skills/changesets/references/policy.md
  • AGENTS.md
  • AGENTS.md
  • CLAUDE.md
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

  • clerk/clerk_go (manual)
  • clerk/dashboard (manual)
  • clerk/accounts (manual)
  • clerk/backoffice (manual)
  • clerk/clerk (manual)
  • clerk/clerk-docs (manual)
  • clerk/cloudflare-workers (manual)
💤 Files with no reviewable changes (1)
  • CLAUDE.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The repository guidance file CLAUDE.md was deleted. Its reference was removed from AGENTS.md. The changeset skill and policy now list AGENTS.md, instead of CLAUDE.md, in the exempt root document paths.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to a0147

This documentation-only change presents no identified production or developer-workflow risk blocking merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly summarizes the main change: replacing the root CLAUDE.md symlink with AGENTS.md.
Description check ✅ Passed The description accurately explains the root instruction-file rename, related changesets documentation updates, intentionally unchanged fixture files, and testing.

Comment @coderabbitai help to get the list of available commands.

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