Skip to content

Add AGENTS.md symlink to CLAUDE.md - #281

Open
zackees wants to merge 1 commit into
mainfrom
agent/agents-md-symlink
Open

zackees wants to merge 1 commit into
mainfrom
agent/agents-md-symlink

Conversation

@zackees

@zackees zackees commented Oct 27, 2026 •

Copy link
Copy Markdown
Member

Non-Claude agents (Codex, OpenCode, Cursor, ...) read AGENTS.md, while Claude Code reads CLAUDE.md.

This adds AGENTS.md as a relative symlink to CLAUDE.md so every agent gets the same instructions and the two can never drift apart. Purely additive: CLAUDE.md is unchanged.

Automated by the agents-md-sync job; not merged automatically.

Summary by CodeRabbit

  • Documentation
    • Made existing project guidance available through an additional entry point. The guidance content is unchanged, and this update does not affect product features or the end-user experience.

@coderabbitai

coderabbitai Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: b0590e89-b96e-4633-95d7-1e35b1684d8e
Commits

Reviewing files that changed from the base of the PR and between d8854e4 and 4bb877d.

Files selected for processing: 1
  • AGENTS.md

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

Walkthrough

AGENTS.md is a symbolic link to CLAUDE.md.

Changes: Agent guidance link

Layer / File(s) Summary
Add AGENTS.md link
AGENTS.md
AGENTS.md is a symbolic link to CLAUDE.md.

Priority: Low

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

Change: Other

Possibly related PRs

  • FastLED/cli#280: This PR changes CLAUDE.md, the file linked by AGENTS.md.
Merge Risk: Minimal · up to 4bb87

No actionable merge-blocking risk was identified.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main change: adding an AGENTS.md symlink to CLAUDE.md.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within survi…
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.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

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.

1 participant