Skip to content

refactor: make AGENTS.md source of truth, CLAUDE.md as symlink#10

Merged
recoupableorg merged 3 commits intomainfrom
feat/agents-md-symlink
Feb 17, 2026
Merged

refactor: make AGENTS.md source of truth, CLAUDE.md as symlink#10
recoupableorg merged 3 commits intomainfrom
feat/agents-md-symlink

Conversation

@sidneyswift
Copy link
Copy Markdown

@sidneyswift sidneyswift commented Feb 16, 2026

Makes AGENTS.md the source of truth for AI agent instructions. CLAUDE.md is now a symlink to it.

Summary by CodeRabbit

Release Notes

  • Documentation
    • Added detailed guidelines for working with Claude Code in this repository, covering Git workflow standards, task initiation procedures, build commands, repository architecture, key technologies, coding principles, and environment variable configuration.
    • Added reference documentation for agent integration patterns and system architecture.

@vercel
Copy link
Copy Markdown

vercel Bot commented Feb 16, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
bash Ready Ready Preview Feb 17, 2026 7:02pm

Request Review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Feb 16, 2026

Warning

Rate limit exceeded

@sidneyswift has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 29 minutes and 48 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

📝 Walkthrough

Walkthrough

This 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

Cohort / File(s) Summary
Documentation Files
AGENTS.md, CLAUDE.md
New documentation files added outlining guidelines for Claude Code integration, including Git workflow, task initiation, build commands, architecture overview, key technologies, coding principles, and environment variable setup.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 Hops excitedly

A guidebook for Claude Code so bright,
New docs to set developers right,
With workflows and principles clear,
The path forward now drawing near! 🎉

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main change: establishing AGENTS.md as the source of truth and converting CLAUDE.md to a symlink.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection ✅ Passed ✅ No merge conflicts detected when merging into main

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat/agents-md-symlink

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 and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

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.

Comment thread AGENTS.md Outdated
@@ -0,0 +1,67 @@
# 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.

⚠️ Potential issue | 🟠 Major

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.

Suggested change
# 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.

@recoupableorg recoupableorg merged commit 4f11645 into main Feb 17, 2026
2 checks passed
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.

3 participants