Skip to content

chore: symlink CLAUDE.md to AGENTS.md#1050

Merged
omeraplak merged 1 commit intoVoltAgent:mainfrom
zrosenbauer:chore/claude-md-symlink
Feb 12, 2026
Merged

chore: symlink CLAUDE.md to AGENTS.md#1050
omeraplak merged 1 commit intoVoltAgent:mainfrom
zrosenbauer:chore/claude-md-symlink

Conversation

@zrosenbauer
Copy link
Contributor

@zrosenbauer zrosenbauer commented Feb 11, 2026

Summary

  • Replaces the CLAUDE.md file with a symlink pointing to AGENTS.md
  • Previously CLAUDE.md just contained a one-liner telling Claude to read AGENTS.md — this removes that indirection
  • Claude Code follows symlinks when resolving CLAUDE.md and .claude/rules/, so the symlink is treated identically to a regular file
  • AGENTS.md remains the canonical source of truth for agent instructions, keeping the door open for other AI coding tools that may adopt AGENTS.md as their convention

Test plan

  • Verify Claude Code loads instructions from AGENTS.md via the symlink
  • Confirm AGENTS.md content appears in Claude Code's project instructions

🤖 Generated with Claude Code


Summary by cubic

Replaced CLAUDE.md with a symlink to AGENTS.md so Claude Code reads the canonical agent instructions directly. This removes the extra indirection and keeps AGENTS.md as the single source of truth while preserving the CLAUDE.md entrypoint.

Written for commit adcfdfd. Summary will update on new commits.

Summary by CodeRabbit

  • Documentation
    • Added new documentation file to the repository.

Claude Code follows symlinks when resolving CLAUDE.md, so we can
point it directly at AGENTS.md instead of having a separate file
that just says "read AGENTS.md". This keeps a single source of
truth for agent instructions while maintaining the CLAUDE.md
entrypoint that Claude Code looks for automatically.

The AGENTS.md file is kept as the canonical source in case other
AI coding tools adopt that convention independently.

Co-Authored-By: Claude Opus 4.6 <[email protected]>
@changeset-bot
Copy link

changeset-bot bot commented Feb 11, 2026

⚠️ No Changeset found

Latest commit: adcfdfd

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
Copy link
Contributor

coderabbitai bot commented Feb 11, 2026

Caution

Review failed

Failed to post review comments

📝 Walkthrough

Walkthrough

A new top-level documentation file AGENTS.md has been added to the repository. No existing files were modified.

Changes

Cohort / File(s) Summary
New Documentation
AGENTS.md
New file created.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A new file arrives, so shiny and bright,
AGENTS.md springs forth into sight!
What wonders within its pages shall dwell,
The rabbit hops onward—a tale yet to tell! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The description provides comprehensive context about the change, rationale, and test plan, though it does not follow the repository's provided template structure with sections like PR Checklist, Bugs/Features, or the specified heading format. Restructure the description to follow the repository template: include PR Checklist section with commit message verification, organize content under 'What is the current behavior?' and 'What is the new behavior?' sections, and include Changesets acknowledgment.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and accurately describes the main change: converting CLAUDE.md into a symlink pointing to AGENTS.md, which aligns perfectly with the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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

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
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

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

No issues found across 2 files

@omeraplak omeraplak merged commit 0b75425 into VoltAgent:main Feb 12, 2026
22 checks passed
@omeraplak
Copy link
Member

Thank you so much @zrosenbauer

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