awesome-awesomeness/html/coderabbit.html

<h1 id="awesome-coderabbit-awesome">Awesome CodeRabbit <a
href="https://awesome.re"><img src="https://awesome.re/badge-flat.svg"
alt="Awesome" /></a></h1>
<p><a href="https://www.coderabbit.ai">CodeRabbit</a> is an AI-powered
code review tool that helps development teams improve code quality and
accelerate the review process. It integrates with popular version
control platforms and provides intelligent feedback on code changes.</p>
<p>This curated list covers the best resources, tutorials, and community
content related to CodeRabbit 🐰</p>
<h2 id="contents">Contents</h2>
<ul>
<li><a href="#official-resources">Official Resources</a></li>
<li><a href="#getting-started">Getting Started</a></li>
<li><a href="#api-reference">API Reference</a></li>
<li><a href="#configuration-examples">Configuration Examples</a></li>
<li><a href="#integration-guides">Integration Guides</a></li>
<li><a href="#video-tutorials">Video Tutorials</a></li>
<li><a href="#blogs">Blogs</a></li>
<li><a href="#media-coverage">Media Coverage</a></li>
<li><a href="#community-reviews">Community Reviews</a></li>
<li><a href="#projects-using-coderabbit">Projects Using
CodeRabbit</a></li>
</ul>
<h2 id="official-resources">Official Resources</h2>
<ul>
<li><a href="https://docs.coderabbit.ai">Documentation</a> -
Comprehensive docs covering all aspects of CodeRabbit.</li>
<li><a href="https://www.coderabbit.ai/blog">Blog</a> - Official blog
featuring updates, tutorials, and best practices.</li>
<li><a href="https://www.coderabbit.ai/faq">FAQ</a> - Frequently asked
questions about CodeRabbit.</li>
<li><a href="https://github.com/coderabbitai/ai-pr-reviewer">GitHub
Repository</a> - Official AI PR Reviewer repository.</li>
<li><a
href="https://www.linkedin.com/company/coderabbitai/">LinkedIn</a> -
Official LinkedIn presence.</li>
<li><a href="https://x.com/coderabbitai">Twitter</a> - Official
Twitter/X account.</li>
<li><a href="https://www.youtube.com/@CodeRabbitAI">YouTube Channel</a>
- Official YouTube channel with tutorials and updates.</li>
</ul>
<h2 id="getting-started">Getting Started</h2>
<ul>
<li><a
href="https://www.coderabbit.ai/blog/coderabbit-startup-program">CodeRabbit
Startup Program</a> - Special program for startups.</li>
<li><a
href="https://www.coderabbit.ai/blog/how-to-use-an-ai-code-reviewer-on-github-in-4-examples">AI
Code Reviewer Examples</a> - Four practical examples of using
CodeRabbit.</li>
</ul>
<h2 id="api-reference">API Reference</h2>
<ul>
<li><a href="https://api.coderabbit.ai/api/swagger/">OpenAPI
Documentation</a> - Complete Swagger documentation for CodeRabbit’s REST
API endpoints.</li>
</ul>
<h2 id="configuration-examples">Configuration Examples</h2>
<h3 id="enterprise-configuration-example">Enterprise Configuration
Example</h3>
<p>Explore real-world CodeRabbit configurations from various
projects.</p>
<div class="sourceCode" id="cb1"><pre
class="sourceCode yaml"><code class="sourceCode yaml"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="co"># yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json</span></span>
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a><span class="fu">language</span><span class="kw">:</span><span class="at"> </span><span class="st">&quot;en-US&quot;</span></span>
<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a><span class="fu">early_access</span><span class="kw">:</span><span class="at"> </span><span class="ch">false</span></span>
<span id="cb1-4"><a href="#cb1-4" aria-hidden="true" tabindex="-1"></a><span class="fu">tone_instructions</span><span class="kw">:</span><span class="at"> </span><span class="st">&#39;You are an expert code reviewer in Java, TypeScript, JavaScript, and NodeJS. You work in an enterprise software developer team, providing concise and clear code review advice. You only elaborate or provide detailed explanations when requested.&#39;</span></span>
<span id="cb1-5"><a href="#cb1-5" aria-hidden="true" tabindex="-1"></a><span class="fu">reviews</span><span class="kw">:</span></span>
<span id="cb1-6"><a href="#cb1-6" aria-hidden="true" tabindex="-1"></a><span class="at">  </span><span class="fu">profile</span><span class="kw">:</span><span class="at"> </span><span class="st">&quot;chill&quot;</span></span>
<span id="cb1-7"><a href="#cb1-7" aria-hidden="true" tabindex="-1"></a><span class="at">  </span><span class="fu">request_changes_workflow</span><span class="kw">:</span><span class="at"> </span><span class="ch">false</span></span>
<span id="cb1-8"><a href="#cb1-8" aria-hidden="true" tabindex="-1"></a><span class="at">  </span><span class="fu">high_level_summary</span><span class="kw">:</span><span class="at"> </span><span class="ch">true</span></span>
<span id="cb1-9"><a href="#cb1-9" aria-hidden="true" tabindex="-1"></a><span class="at">  </span><span class="fu">poem</span><span class="kw">:</span><span class="at"> </span><span class="ch">true</span></span>
<span id="cb1-10"><a href="#cb1-10" aria-hidden="true" tabindex="-1"></a><span class="at">  </span><span class="fu">review_status</span><span class="kw">:</span><span class="at"> </span><span class="ch">true</span></span>
<span id="cb1-11"><a href="#cb1-11" aria-hidden="true" tabindex="-1"></a><span class="at">  </span><span class="fu">collapse_walkthrough</span><span class="kw">:</span><span class="at"> </span><span class="ch">false</span></span>
<span id="cb1-12"><a href="#cb1-12" aria-hidden="true" tabindex="-1"></a><span class="at">  </span><span class="fu">auto_review</span><span class="kw">:</span></span>
<span id="cb1-13"><a href="#cb1-13" aria-hidden="true" tabindex="-1"></a><span class="at">    </span><span class="fu">enabled</span><span class="kw">:</span><span class="at"> </span><span class="ch">true</span></span>
<span id="cb1-14"><a href="#cb1-14" aria-hidden="true" tabindex="-1"></a><span class="at">    </span><span class="fu">drafts</span><span class="kw">:</span><span class="at"> </span><span class="ch">false</span></span>
<span id="cb1-15"><a href="#cb1-15" aria-hidden="true" tabindex="-1"></a><span class="at">    </span><span class="fu">base_branches</span><span class="kw">:</span><span class="at"> </span><span class="kw">[</span><span class="st">&quot;pg&quot;</span><span class="kw">,</span><span class="at"> </span><span class="st">&quot;release&quot;</span><span class="kw">]</span></span>
<span id="cb1-16"><a href="#cb1-16" aria-hidden="true" tabindex="-1"></a><span class="at">  </span><span class="fu">path_instructions</span><span class="kw">:</span></span>
<span id="cb1-17"><a href="#cb1-17" aria-hidden="true" tabindex="-1"></a><span class="at">    </span><span class="kw">-</span><span class="at"> </span><span class="fu">path</span><span class="kw">:</span><span class="at"> </span><span class="st">&quot;app/client/cypress/**/**.*&quot;</span></span>
<span id="cb1-18"><a href="#cb1-18" aria-hidden="true" tabindex="-1"></a><span class="fu">      instructions</span><span class="kw">: </span><span class="ch">|</span></span>
<span id="cb1-19"><a href="#cb1-19" aria-hidden="true" tabindex="-1"></a>        Review the following e2e test code written using the Cypress test library. Ensure that:</span>
<span id="cb1-20"><a href="#cb1-20" aria-hidden="true" tabindex="-1"></a>        - Follow best practices for Cypress code and e2e automation</span>
<span id="cb1-21"><a href="#cb1-21" aria-hidden="true" tabindex="-1"></a>        - Avoid using cy.wait in code</span>
<span id="cb1-22"><a href="#cb1-22" aria-hidden="true" tabindex="-1"></a>        - Avoid using cy.pause in code</span>
<span id="cb1-23"><a href="#cb1-23" aria-hidden="true" tabindex="-1"></a>        - Avoid using agHelper.sleep()</span>
<span id="cb1-24"><a href="#cb1-24" aria-hidden="true" tabindex="-1"></a>        - Use locator variables for locators</span>
<span id="cb1-25"><a href="#cb1-25" aria-hidden="true" tabindex="-1"></a>        - Use data-* attributes for selectors</span>
<span id="cb1-26"><a href="#cb1-26" aria-hidden="true" tabindex="-1"></a>        - Avoid Xpaths, Attributes and CSS path</span>
<span id="cb1-27"><a href="#cb1-27" aria-hidden="true" tabindex="-1"></a>        - Avoid selectors like .btn.submit</span>
<span id="cb1-28"><a href="#cb1-28" aria-hidden="true" tabindex="-1"></a>        - Perform logins via API</span>
<span id="cb1-29"><a href="#cb1-29" aria-hidden="true" tabindex="-1"></a>        - Avoid using it.only</span>
<span id="cb1-30"><a href="#cb1-30" aria-hidden="true" tabindex="-1"></a>        - Use multiple assertions</span>
<span id="cb1-31"><a href="#cb1-31" aria-hidden="true" tabindex="-1"></a>        - Avoid string assertions</span>
<span id="cb1-32"><a href="#cb1-32" aria-hidden="true" tabindex="-1"></a>        - Ensure unique filenames</span>
<span id="cb1-33"><a href="#cb1-33" aria-hidden="true" tabindex="-1"></a><span class="fu">chat</span><span class="kw">:</span></span>
<span id="cb1-34"><a href="#cb1-34" aria-hidden="true" tabindex="-1"></a><span class="at">  </span><span class="fu">auto_reply</span><span class="kw">:</span><span class="at"> </span><span class="ch">true</span></span></code></pre></div>
<p>Find more examples in the <a
href="configs/"><code>configs/</code></a> directory, organized by
language:</p>
<pre><code>configs/
├── javascript/   # JavaScript project configurations
├── typescript/   # TypeScript project configurations
├── python/       # Python project configurations
├── go/          # Go project configurations
└── multi-language/ # Full-stack project configurations</code></pre>
<h2 id="integration-guides">Integration Guides</h2>
<ul>
<li><a
href="https://www.coderabbit.ai/blog/getting-started-with-coderabbit-using-azure-devops">Azure
DevOps Integration</a> - Guide for integrating with Azure DevOps.</li>
<li><a
href="https://www.coderabbit.ai/blog/how-to-run-static-analysis-on-your-ci-cd-pipelines-using-ai">CI/CD
Pipeline Integration</a> - Adding AI-powered static analysis to CI/CD
pipelines.</li>
<li><a
href="https://www.coderabbit.ai/blog/how-to-use-coderabbit-to-validate-issues-against-linear-board">Linear
Board Integration</a> - Guide for Linear board integration.</li>
<li><a
href="https://www.coderabbit.ai/blog/how-to-integrate-ai-code-review-into-your-devops-pipeline">DevOps
Pipeline Integration</a> - Comprehensive DevOps integration guide.</li>
</ul>
<h2 id="video-tutorials">Video Tutorials</h2>
<ul>
<li><a href="https://www.youtube.com/watch?v=3SyUOSebG7E">Getting
Started Tutorial</a> - Official step-by-step guide for new users.</li>
</ul>
<h2 id="blogs">Blogs</h2>
<ul>
<li><a
href="https://tomaszs2.medium.com/ai-can-make-a-code-review-for-free-a559cf74efa5">AI
Can Make a Code Review for Free</a></li>
<li><a
href="https://www.coderabbit.ai/blog/coderabbit-deep-dive">CodeRabbit
Deep Dive</a></li>
<li><a
href="https://www.devtoolsacademy.com/blog/coderabbit-vs-others-ai-code-review-tools">CodeRabbit
vs Others: AI Code Review Tools</a></li>
<li><a
href="https://www.coderabbit.ai/blog/why-developers-hate-linters">Why
Developers Hate Linters</a></li>
<li><a
href="https://www.coderabbit.ai/blog/how-to-automate-typescript-code-reviews-with-coderabbit">How
to Automate TypeScript Code Reviews with CodeRabbit</a></li>
</ul>
<h2 id="media-coverage">Media Coverage</h2>
<ul>
<li><a
href="https://techcrunch.com/2024/08/15/coderabbit-raises-16m-to-bring-ai-to-code-reviews/">TechCrunch
Coverage</a> - TechCrunch article on CodeRabbit’s $16M funding.</li>
<li><a
href="https://siliconangle.com/2024/08/14/ai-code-review-startup-coderabbit-raises-16m-help-developers-debug-code-faster/">Silicon
Angle Feature</a> - Coverage of CodeRabbit’s funding and mission.</li>
</ul>
<h2 id="community-reviews">Community Reviews</h2>
<ul>
<li><a href="https://www.g2.com/products/coderabbit/reviews">G2
Reviews</a> - Verified user reviews and ratings.</li>
<li><a
href="https://tomaszs2.medium.com/ai-code-review-tool-coderabbit-replaces-me-and-i-like-it-b1350a9cda58">Developer
Testimonials</a> - Real-world experiences with CodeRabbit.</li>
</ul>
<h2 id="projects-using-coderabbit">Projects Using CodeRabbit</h2>
<blockquote>
<p>Here is a list of some of the open-source projects using CodeRabbit
for AI-powered code reviews.</p>
</blockquote>
<ul>
<li><a href="https://github.com/appsmithorg/appsmith">Appsmith</a> -
Low-code platform for building internal tools <a
href="https://github.com/appsmithorg/appsmith/pull/37200">Example
Review</a>.</li>
<li><a href="https://github.com/CrowdDotDev/crowd.dev">Crowd.dev</a> -
Open-source developer community platform <a
href="https://github.com/CrowdDotDev/crowd.dev/pull/2671">Example
Review</a>.</li>
<li><a href="https://github.com/documenso/documenso">Documenso</a> -
Open-source DocuSign alternative <a
href="https://github.com/documenso/documenso/pull/1436">Example
Review</a>.</li>
<li><a href="https://github.com/formbricks/formbricks">Formbricks</a> -
Open-source survey &amp; experience management solution <a
href="https://github.com/formbricks/formbricks/pull/4229">Example
Review</a>.</li>
<li><a href="https://github.com/neondatabase/neon">Neon</a> - Serverless
Postgres database platform <a
href="https://github.com/neondatabase/neon/pull/9100">Example
Review</a>.</li>
<li><a href="https://github.com/nextui-org/nextui">NextUI</a> -
Beautiful, fast, and modern React UI library <a
href="https://github.com/nextui-org/nextui/pull/3680">Example
Review</a>.</li>
<li><a href="https://github.com/novuhq/novu">Novu</a> - Open-source
notification infrastructure <a
href="https://github.com/novuhq/novu/pull/5401">Example Review</a>.</li>
<li><a href="https://github.com/openobserve/openobserve">OpenObserve</a>
- A cloud-native observability platform <a
href="https://github.com/openobserve/openobserve/pull/4865">Example
Review</a>.</li>
<li><a href="https://github.com/Permify/permify">Permify</a> -
Authorization service &amp; policy engine <a
href="https://github.com/Permify/permify/pull/1754">Example
Review</a>.</li>
<li><a href="https://github.com/PipedreamHQ/pipedream">Pipedream</a> -
Connect APIs, remarkably fast <a
href="https://github.com/PipedreamHQ/pipedream/pull/14498">Example
Review</a>.</li>
<li><a href="https://github.com/makeplane/plane">Plane</a> - Open-source
project management tool <a
href="https://github.com/makeplane/plane/pull/5933">Example
Review</a>.</li>
<li><a href="https://github.com/unkeyed/unkey">Unkey</a> - API key
management solution <a
href="https://github.com/unkeyed/unkey/pull/2639">Example
Review</a>.</li>
<li><a href="https://github.com/pingdotgg/uploadthing">UploadThing</a> -
File upload solution for modern web <a
href="https://github.com/pingdotgg/uploadthing/pull/1038">Example
Review</a>.</li>
</ul>
<p><a
href="https://github.com/coderabbitai/awesome-coderabbit">coderabbit.md
Github</a></p>