Skip to content

feat(docs): Add AGENTS.md symlink for agents.md compatibility #832

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yamadashy merged 1 commit into from
Sep 12, 2025
Merged

feat(docs): Add AGENTS.md symlink for agents.md compatibility #832

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.agents/rules/base.md
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot Sep 12, 2025

Choose a reason for hiding this comment

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

medium

This change introduces a symbolic link for AGENTS.md. While this is a clean solution for Unix-based systems, it can lead to issues on Windows where Git's support for symlinks is not enabled by default. Without core.symlinks=true, Git will create a text file containing the path .agents/rules/base.md instead of a functional symlink. This would break the feature for many Windows users.

Given that the project supports Windows, you might consider an alternative approach to ensure cross-platform compatibility. For example, you could use a script to copy the content during a build step to keep the files synchronized.

If you choose to proceed with the symlink, I recommend adding a note to the CONTRIBUTING.md or README.md about the required Git configuration for Windows developers.

Loading