Skip to content

chore: remove root CLAUDE.md in favor of AGENTS.md - #21542

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

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

Conversation

@jarrensj

@jarrensj jarrensj commented Sep 18, 2026 •

Copy link
Copy Markdown

ELI5

The repo has two files that tell coding agents how to work here. One of them just says "read the other one". This removes the one that only points at the other.

What Changed

Deletes the root CLAUDE.md, which contained only @AGENTS.md. AGENTS.md itself and the nested AGENTS.md files under src/main/daemon, tests, and tests/e2e are unchanged.

The two config lists that name CLAUDE.md are left as-is on purpose: the electron-builder packaging exclude glob in config/electron-builder.config.cjs and the docs-only path classifier in config/scripts/pr-code-change-scope.mjs. Both are generic lists covering several filenames and still behave correctly whether or not the file exists.

Why

As of Claude Code v2.1.277, Claude Code reads AGENTS.md directly in a project with no CLAUDE.md, so the import shim is redundant. Keeping a single instruction file avoids the two drifting apart.

Linked Issue

No issue. Repo housekeeping only.

Visual Proof

N/A. No UI or behavior change; only a one-line agent-instruction file is removed.

Testing

  • git grep CLAUDE.md shows no references to the root file outside the two generic config lists above and product code that handles users' own agent files.

  • No code paths change, so no runtime testing applies.

  • I manually tested these changes locally

  • Automated tests added/updated, or explained why not below

Claude Code now reads AGENTS.md directly, so the CLAUDE.md that only
imports it via @AGENTS.md is redundant. Keeping a single instruction
file avoids the two drifting apart.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Sep 18, 2026 •

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Advanced

Run ID: bbe4e5c0-6c36-455f-8ded-8d42f20282a3

📥 Commits

Reviewing files that changed from the base of the PR and between a7b9ea5 and 8a958f3.

📒 Files selected for processing (1)
  • CLAUDE.md
💤 Files with no reviewable changes (1)
  • CLAUDE.md

Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review.


📝 Walkthrough

Walkthrough

Removed the @AGENTS.md directive line from CLAUDE.md. No exported or public entity declarations changed.

Priority: ⬇️ Low

Merge Risk: ⚪ Minimal · up to 8a958

No actionable merge risk remains from this documentation cleanup.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the change, reason, scope, testing, and lack of visual impact. However, it explicitly provides no linked issue despite the template requiring one, and it omits the Review, Age… Provide a valid linked issue after "Fixes #" or document an approved exception. Complete the omitted template sections, including Review, Agent skill upstream boundary, Notes, and Checklist.
✅ Passed checks (4 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 identifies the main change: removing the root CLAUDE.md in favor of AGENTS.md.
Full details: Description check

Explanation

The description explains the change, reason, scope, testing, and lack of visual impact. However, it explicitly provides no linked issue despite the template requiring one, and it omits the Review, Agent skill upstream boundary, Notes, and Checklist sections.

  • Fix all pre-merge checks with AI

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@pullfrog pullfrog Bot left a comment

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.

✅ No new issues found.

Reviewed changes

  • Remove root CLAUDE.md — deletes the one-line import shim (@AGENTS.md); root and nested AGENTS.md files are unchanged, and the two generic config lists that still name CLAUDE.md (config/electron-builder.config.cjs, config/scripts/pr-code-change-scope.mjs) behave the same with or without the file.

I confirmed the load-bearing claim against the linked release notes: Claude Code v2.1.277 added "in a project with no CLAUDE.md, Claude Code reads AGENTS.md instead." All remaining CLAUDE.md references in the tree are generic config lists or product code/tests handling users' own agent files, none of which read this repo's root file.

Pullfrog  | View workflow run | Using DeepSeek Flash (free via Pullfrog for OSS) | 𝕏

@OrcaWin

OrcaWin commented Oct 27, 2026

Copy link
Copy Markdown
Collaborator

Thanks for the cleanup, @jarrensj! This exact removal has since landed in #31242: the root CLAUDE.md shim is gone, and AGENTS.md remains the repo’s instruction file. I’m closing this as already covered on main. Appreciate you explaining the compatibility background and keeping the change focused.

@OrcaWin OrcaWin closed this Oct 27, 2026
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.

2 participants