From a3f86124c449475d95f7b0fb337f5709a17748c7 Mon Sep 17 00:00:00 2001 From: Syed Ali Naqi Hasni Date: Tue, 14 Oct 2025 17:13:12 +0500 Subject: [PATCH 1/2] #4 Added Best Practice MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### Description I propose adding a new **“Best Practices”** section to the `awesome-coderabbit` repository. This section would provide valuable guidance for users on how to get the most out of **CodeRabbit’s AI code review capabilities** by consolidating proven strategies and configuration examples in one place. --- ### Proposed Content #### 🧩 Configuration Best Practices - Tips for optimizing the `.coderabbit.yaml` configuration file - Examples of effective `tone_instructions` for different team contexts - Strategies for using `path_instructions` effectively to target specific code areas #### 🔄 Review Workflow Best Practices - Guidelines for integrating CodeRabbit into existing code review processes - Tips for interpreting and acting on AI-generated feedback - Best practices for fostering team collaboration with AI-assisted reviews #### 💻 Language-Specific Best Practices - Recommendations for **JavaScript/TypeScript** projects - Recommendations for **Python** projects - Guidance for other popular languages commonly supported by CodeRabbit #### ⚙️ Performance Optimization - Tips for reducing review time without sacrificing quality - Strategies for focusing reviews on critical code areas - Guidelines for balancing review **thoroughness** and **speed** --- ### Implementation The new **“Best Practices”** section should be added: - **After:** the “Configuration Examples” section - **Before:** the “Integration Guides” section in `README.md` --- ### Benefits - 🧭 **Helps new users** quickly adopt CodeRabbit with practical guidance - 🚀 **Improves productivity** through clear optimization strategies - 📚 **Centralizes knowledge** currently scattered across blogs and documentation - 💎 **Enhances repository value** as a comprehensive learning and reference resource --- ### References - [CodeRabbit Documentation](https://docs.coderabbit.ai) - [Official Blog: Best Practices & Use Cases](https://www.coderabbit.ai/blog) - [Example Configurations](https://github.com/coderabbitai/awesome-coderabbit/tree/main/configs) --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index e6298b7..3595d70 100644 --- a/README.md +++ b/README.md @@ -138,3 +138,34 @@ configs/ - [Plane](https://github.com/makeplane/plane) - Open-source project management tool [Example Review](https://github.com/makeplane/plane/pull/5933). - [Unkey](https://github.com/unkeyed/unkey) - API key management solution [Example Review](https://github.com/unkeyed/unkey/pull/2639). - [UploadThing](https://github.com/pingdotgg/uploadthing) - File upload solution for modern web [Example Review](https://github.com/pingdotgg/uploadthing/pull/1038). + +## Best Practices + +When using **CodeRabbit** for AI-powered code reviews, following a few best practices helps maximize accuracy, maintain consistency, and ensure high-quality feedback: + +1. **Provide Context in Pull Requests** + Include clear PR titles and descriptions. Mention the purpose, scope, and any edge cases to help CodeRabbit generate relevant feedback. + +2. **Refine Configuration Regularly** + - Use the `tone_instructions` and `path_instructions` fields to tailor reviews by code area. + - Update your YAML configuration as your codebase evolves. + - Keep `reviews.profile` consistent across repositories to maintain tone alignment. + +3. **Leverage Auto Reviews Wisely** + Enable `auto_review` for major branches (`main`, `release`, etc.) only. Disable for WIP or experimental branches to reduce noise. + +4. **Combine AI + Human Insight** + Use CodeRabbit’s feedback as a *first pass*. Developers should still review key logic and architecture changes manually. + +5. **Optimize for Performance & Security** + Configure path-level rules to ensure sensitive files (e.g., `.env`, secrets) are excluded from reviews or uploads. + +6. **Integrate with CI/CD** + Run CodeRabbit checks alongside your CI tests to automatically block merges if issues exceed a defined threshold. + +7. **Encourage Team Feedback** + Collect feedback from developers on AI review accuracy and continuously refine configuration files for better alignment. + +8. **Document Custom Instructions** + Maintain a central `CODE_REVIEW_GUIDE.md` documenting your preferred CodeRabbit settings, tone, and workflow for new team members. + From ce48c93eb881ffcb884c738a009865f2889b0c9c Mon Sep 17 00:00:00 2001 From: Syed Ali Naqi Hasni Date: Tue, 14 Oct 2025 19:43:05 +0500 Subject: [PATCH 2/2] #7 Removed OpenApi Documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The OpenAPI documentation link provided in the README.md file is currently broken or inaccessible. When users click the link, they are either redirected to a missing page or encounter an error. This affects developers and contributors trying to access the project’s API documentation directly from the repository. --- README.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/README.md b/README.md index 3595d70..2a90aaf 100644 --- a/README.md +++ b/README.md @@ -32,10 +32,6 @@ This curated list covers the best resources, tutorials, and community content re - [CodeRabbit Startup Program](https://www.coderabbit.ai/blog/coderabbit-startup-program) - Special program for startups. - [AI Code Reviewer Examples](https://www.coderabbit.ai/blog/how-to-use-an-ai-code-reviewer-on-github-in-4-examples) - Four practical examples of using CodeRabbit. -## API Reference - -- [OpenAPI Documentation](https://api.coderabbit.ai/api/swagger/) - Complete Swagger documentation for CodeRabbit's REST API endpoints. - ## Configuration Examples ### Enterprise Configuration Example