chore: Symlink CLAUDE.md to AGENTS.md #2279
Conversation
Creates a CLAUDE.md symlink pointing to AGENTS.md so Claude Code (the Anthropic CLI tool) automatically picks up the project's AI assistant rules without duplicating content. Updates CONTRIBUTING.md to document the symlink under the AI assistant rules structure section, alongside the existing Cursor-specific rules. https://claude.ai/code/session_01Y6n2rcJX5NJ3UqiCJ45WZ9
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.
This is the final PR Bugbot will review for you during this billing cycle
Your free Bugbot reviews will reset on March 24
Details
Your team is on the Bugbot Free tier. On this plan, Bugbot will review limited PRs each billing cycle for each member of your team.
To receive Bugbot reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.
Comment @cursor review or bugbot run to trigger another review on this PR
| @@ -0,0 +1 @@ | |||
| AGENTS.md No newline at end of file | |||
There was a problem hiding this comment.
Symlink CLAUDE.md won't work reliably across platforms
Medium Severity
CLAUDE.md is created as a symlink to AGENTS.md, but Claude Code documentation states it expects a "standard markdown text file (not a symlink)." On Windows, where git typically materializes symlinks as regular text files, this results in CLAUDE.md containing only the literal text AGENTS.md rather than the actual project rules. Claude Code also has documented symlink resolution bugs (anthropics/claude-code issues #764, #10522). This means contributors on Windows (or in environments where symlinks aren't supported) would have Claude Code read useless single-line instructions instead of the actual project standards.
raethlo
changed the title
raethlo
changed the title
|
Preview for this PR was built for commit |
|
CLAUDE.md need to be added to markdownlint exceptions otherwise it will go crazy. I'll fix it and it should be ready to merge after that |
|
Preview for this PR was built for commit |
4 participants
Creates a CLAUDE.md symlink pointing to AGENTS.md so Claude Code (the Anthropic CLI tool) automatically picks up the project's AI assistant rules without duplicating content.
https://claude.ai/code/session_01Y6n2rcJX5NJ3UqiCJ45WZ9
Note
Low Risk
Adds a new top-level rules file reference only; no product code or runtime behavior is affected.
Overview
Adds
CLAUDE.mdcontainingAGENTS.mdso Claude Code can automatically pick up the repository’s AI assistant rules without duplicating the vendor-agnostic guidelines.Written by Cursor Bugbot for commit f5a910d. Configure here.