Skip to content

Replace CLAUDE.md symlink with @AGENTS.md import - #1577

Open
lazerg wants to merge 1 commit into
open-circle:mainfrom
lazerg:fix-claude-md-symlink
Open

Replace CLAUDE.md symlink with @AGENTS.md import#1577
lazerg wants to merge 1 commit into
open-circle:mainfrom
lazerg:fix-claude-md-symlink

Conversation

@lazerg

@lazerg lazerg commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Git for Windows does not create symlinks unless the clone sets core.symlinks=true and the user has Administrator rights or Developer Mode enabled. Without that, CLAUDE.md lands as a regular file whose entire content is the string AGENTS.md, so Claude Code loads that as the project instructions instead of the real ones.

The Claude Code memory docs recommend the @AGENTS.md import for this case, so this replaces the symlink with a one-line file. Nothing changes on macOS and Linux, where both forms resolve to the same content.

Fixes #1576

Summary by CodeRabbit

  • Documentation
    • Updated project guidance to remove an outdated reference.
    • No changes were made to application functionality or the end-user experience.

@dosubot dosubot Bot added size:XS This PR changes 0-9 lines, ignoring generated files. fix A smaller enhancement or bug fix labels Aug 5, 2026
@coderabbitai

coderabbitai Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 8d7a97e9-4d71-427e-9a5a-950d095c877b

📥 Commits

Reviewing files that changed from the base of the PR and between e789528 and 9eb160d.

📒 Files selected for processing (2)
  • CLAUDE.md
  • CLAUDE.md

Walkthrough

Removed the AGENTS.md entry from CLAUDE.md.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly states that the CLAUDE.md symlink is replaced with an @AGENTS.md import.
Linked Issues check ✅ Passed The change addresses issue #1576 by replacing the Windows-unreliable CLAUDE.md symlink with the recommended @AGENTS.md import.
Out of Scope Changes check ✅ Passed The change is limited to CLAUDE.md and directly supports the linked issue's Windows compatibility objective.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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.

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

Copy link
Copy Markdown

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

Re-trigger cubic

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

fix A smaller enhancement or bug fix size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Revert CLAUDE.md symlink for Windows users

1 participant