chore(config): consolidate AI assistant rules configuration#726
chore(config): consolidate AI assistant rules configuration#726
Conversation
Remove .clinerules and .cursorrules files as they are no longer needed. Update CLAUDE.md to be a symlink to .agents/rules/base.md for centralized rule management and better maintainability. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Add .github/copilot-instructions.md to provide guidance for GitHub Copilot when working with this repository. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.
WalkthroughThis change removes the Changes
Possibly related PRs
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (5)
💤 Files with no reviewable changes (2)
🧰 Additional context used🧠 Learnings (2)📓 Common learnings.github/copilot-instructions.md (2)⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (10)
✨ 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
|
Claude finished @yamadashy's task —— View job PR Review: Consolidate AI Assistant Rules ConfigurationTodo List:
🔍 Review SummaryThis PR successfully consolidates AI assistant rules configuration by centralizing all rules in ✅ Positive Aspects
|
![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 focuses on improving the maintainability and consistency of AI assistant configurations by centralizing all relevant rules into a single, authoritative file. The change ensures that various AI tools, such as Claude Code and GitHub Copilot, operate under a unified set of guidelines, simplifying future updates and management while removing redundant legacy configurations.
Highlights
- Configuration Consolidation: Centralized all AI assistant rules into a single source of truth located at
.agents/rules/base.md. - Legacy File Removal: Removed outdated and redundant configuration files, specifically
.clinerulesand.cursorrules, as part of the consolidation effort to streamline rule management. - Claude Integration Update: Converted the
CLAUDE.mdfile from a regular markdown document containing specific rules to a symbolic link that now points directly to the new centralized rules file (.agents/rules/base.md). - GitHub Copilot Integration: Introduced a new configuration file,
.github/copilot-instructions.md, which is implemented as a symbolic link to the centralized rules file, ensuring GitHub Copilot adheres to the consolidated guidelines.
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 is currently in preview and 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 to provide feedback.
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. ↩
Deploying repomix with
|
| Latest commit: |
9e32764
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://2dd24731.repomix.pages.dev |
| Branch Preview URL: | https://chore-rule.repomix.pages.dev |
There was a problem hiding this comment.
Pull Request Overview
Centralize AI assistant rules by consolidating all configurations into a single source of truth and removing outdated files.
- Removed legacy
.cursorrulesand.clinerules - Converted
CLAUDE.mdto a symlink for.agents/rules/base.md - Added a symlink for GitHub Copilot instructions in
.github/copilot-instructions.md
Reviewed Changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| CLAUDE.md | Replaced content with a symlink to .agents/rules/base.md |
| .github/copilot-instructions.md | Added as a symlink to .agents/rules/base.md |
| .cursorrules | Deleted legacy rule file |
| .clinerules | Deleted legacy rule file |
| @@ -0,0 +1 @@ | |||
| ../.agents/rules/base.md No newline at end of file | |||
There was a problem hiding this comment.
Similarly, mark this file as a symlink in Git (file mode 120000) so tooling correctly follows the link to the centralized rules.
| ../.agents/rules/base.md | |
| # This file will be replaced with a symbolic link to ../.agents/rules/base.md. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #726 +/- ##
=======================================
Coverage 90.40% 90.40%
=======================================
Files 99 99
Lines 5710 5710
Branches 1193 1193
=======================================
Hits 5162 5162
Misses 548 548 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Code Review
This pull request aims to improve maintainability by consolidating AI assistant rules into a single source of truth and using symlinks to point to it. This is a good goal for reducing duplication.
My main feedback concerns the use of symlinks. While elegant, they can introduce portability and compatibility issues if the consuming tools or developer environments don't handle them correctly. I've raised this as a high-severity concern for both CLAUDE.md and .github/copilot-instructions.md, suggesting a more robust approach like content synchronization to ensure the rules are always accessible as intended.
| @@ -0,0 +1 @@ | |||
| ../.agents/rules/base.md No newline at end of file | |||
There was a problem hiding this comment.
Using a symlink to centralize AI rules is a clean approach for maintainability. However, it introduces a dependency on the consuming tool's ability to follow symlinks. If GitHub Copilot or the environment it runs in (e.g., certain Windows configurations without symlink support enabled for Git) doesn't handle symlinks correctly, it might read the literal path ../.agents/rules/base.md as the instruction, rather than the content of the target file. This would defeat the purpose of providing contextual rules.
To ensure robustness and portability across different developer environments, it would be safer for this file to contain the actual rules, synchronized from the base.md source via a build script or a pre-commit hook. This guarantees that any tool reading this file gets the correct content without relying on symlink resolution.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Consolidate AI assistant rules configuration by centralizing all rules in
.agents/rules/base.mdand removing legacy rule files.Changes
.clinerulesand.cursorrulesfiles that contained outdated or redundant configurations.agents/rules/base.mdfor centralized rule management.github/copilot-instructions.mdas a symlink to the centralized rules fileThis change improves maintainability by having a single source of truth for AI assistant rules while ensuring compatibility with different AI tools (Claude Code, GitHub Copilot, Cursor, etc.).
Checklist
npm run testnpm run lint