feat(docs): Add AGENTS.md symlink for agents.md compatibility#832
feat(docs): Add AGENTS.md symlink for agents.md compatibility#832
Conversation
Created AGENTS.md as a symlink to .agents/rules/base.md to support the agents.md format specification. This allows AI coding tools that follow the agents.md standard to automatically discover project-specific instructions and guidelines, complementing the existing CLAUDE.md setup. The symlink approach ensures both files stay synchronized while supporting multiple AI coding agent formats.
|
Caution Review failedThe pull request is closed. WalkthroughAdds a single documentation reference in AGENTS.md pointing to .agents/rules/base.md. No code or API changes. Changes
Sequence Diagram(s)(omitted) Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. 📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
✨ Finishing touches🧪 Generate unit tests
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. Comment |
There was a problem hiding this comment.
Pull Request Overview
This PR adds an AGENTS.md symlink to enable compatibility with the agents.md format specification used by AI coding tools. The symlink points to the existing .agents/rules/base.md file to maintain consistency with the current project structure while supporting the standardized agents.md format.
- Creates AGENTS.md as a symlink to
.agents/rules/base.md - Enables automatic discovery of project-specific instructions by AI coding tools
- Maintains synchronization with existing agent configuration without duplication
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @yamadashy, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request introduces a new symbolic link, AGENTS.md, which references the existing .agents/rules/base.md file. The primary purpose of this addition is to enhance the project's compatibility with the agents.md standard, thereby enabling a broader range of AI coding tools to seamlessly integrate and access project-specific guidelines. This approach avoids content duplication while standardizing how AI agents interact with the codebase.
Highlights
- New Symlink Added: A new file named AGENTS.md has been created as a symbolic link.
- Standard Compatibility: This symlink points to .agents/rules/base.md, ensuring compatibility with the widely adopted agents.md specification used by over 20,000 open-source projects.
- Enhanced AI Tooling Support: The change allows various AI coding tools (e.g., Cursor, GitHub Copilot, Gemini CLI) to automatically discover and utilize project-specific instructions, aligning with an open standard for predictable agent guidance.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request introduces AGENTS.md as a symbolic link to .agents/rules/base.md to support the agents.md standard. While this is a good approach for Unix-like systems, I have a concern about its compatibility with Windows, as Git's handling of symlinks on that platform can be inconsistent without specific user configuration. I've left a comment with more details and suggestions.
| @@ -0,0 +1 @@ | |||
| .agents/rules/base.md No newline at end of file | |||
There was a problem hiding this comment.
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.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #832 +/- ##
=======================================
Coverage 87.36% 87.36%
=======================================
Files 113 113
Lines 6626 6626
Branches 1372 1372
=======================================
Hits 5789 5789
Misses 837 837 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Add AGENTS.md as a symlink to support the agents.md format specification.
Summary
.agents/rules/base.mdBenefits
Checklist
npm run testnpm run lint