refactor: make AGENTS.md source of truth, CLAUDE.md as symlink#10
refactor: make AGENTS.md source of truth, CLAUDE.md as symlink#10recoupableorg merged 3 commits intomainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughThis pull request adds two new documentation files providing guidelines for working with Claude Code in the repository. The documentation covers Git workflows, build commands, architecture, key technologies, coding principles, and environment variable configuration. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
Verify each finding against the current code and only fix it if needed.
In `@AGENTS.md`:
- Line 1: The top-level heading in AGENTS.md is incorrect: change the heading
text from "# CLAUDE.md" to "# AGENTS.md" so the document title matches the
filename and PR objective that AGENTS.md is the source of truth for AI agent
instructions; update any other occurrences of "CLAUDE.md" in the same file to
"AGENTS.md" if present to keep the content consistent.
- Line 3: The front-matter sentence "This file provides guidance to Claude Code
(claude.ai/code) when working with code in this repository." is too narrow;
update it to state that AGENTS.md is the canonical guidance for AI agents (not
just Claude Code) — mention that it serves as the source of truth for agent
instructions and that CLAUDE.md is a symlink to it; replace the specific "Claude
Code (claude.ai/code)" phrase with a broader descriptor like "AI agents (e.g.,
Claude, other automated/code-assistant agents)" and ensure the opening line
clearly conveys that AGENTS.md contains general agent guidelines for interacting
with this repository.
🧹 Nitpick comments (1)
🤖 Fix all nitpicks with AI agents
Verify each finding against the current code and only fix it if needed. In `@AGENTS.md`: - Line 3: The front-matter sentence "This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository." is too narrow; update it to state that AGENTS.md is the canonical guidance for AI agents (not just Claude Code) — mention that it serves as the source of truth for agent instructions and that CLAUDE.md is a symlink to it; replace the specific "Claude Code (claude.ai/code)" phrase with a broader descriptor like "AI agents (e.g., Claude, other automated/code-assistant agents)" and ensure the opening line clearly conveys that AGENTS.md contains general agent guidelines for interacting with this repository.AGENTS.md (1)
3-3: Update description to reflect broader agent scope.Since this file is now named AGENTS.md and serves as the source of truth for AI agent instructions (with CLAUDE.md symlinking to it), the description should reflect that it provides guidance to AI agents more broadly, not just "Claude Code."
📝 Proposed update for broader scope
-This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. +This file provides guidance to AI agents (including Claude Code at claude.ai/code) when working with code in this repository.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@AGENTS.md` at line 3, The front-matter sentence "This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository." is too narrow; update it to state that AGENTS.md is the canonical guidance for AI agents (not just Claude Code) — mention that it serves as the source of truth for agent instructions and that CLAUDE.md is a symlink to it; replace the specific "Claude Code (claude.ai/code)" phrase with a broader descriptor like "AI agents (e.g., Claude, other automated/code-assistant agents)" and ensure the opening line clearly conveys that AGENTS.md contains general agent guidelines for interacting with this repository.
| @@ -0,0 +1,67 @@ | |||
| # CLAUDE.md | |||
There was a problem hiding this comment.
Inconsistent heading: File is AGENTS.md but titled "CLAUDE.md".
The file is named AGENTS.md but the heading says "# CLAUDE.md". According to the PR objectives, AGENTS.md is intended to be the source of truth for AI agent instructions. The heading should reflect the actual filename to avoid confusion.
📝 Proposed fix to correct the heading
-# CLAUDE.md
+# AGENTS.md📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # CLAUDE.md | |
| # AGENTS.md |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@AGENTS.md` at line 1, The top-level heading in AGENTS.md is incorrect: change
the heading text from "# CLAUDE.md" to "# AGENTS.md" so the document title
matches the filename and PR objective that AGENTS.md is the source of truth for
AI agent instructions; update any other occurrences of "CLAUDE.md" in the same
file to "AGENTS.md" if present to keep the content consistent.
Makes
AGENTS.mdthe source of truth for AI agent instructions.CLAUDE.mdis now a symlink to it.Summary by CodeRabbit
Release Notes