Skip to content

README.md

Latest commit

 

History

History
141 lines (112 loc) · 6.21 KB

README.md

File metadata and controls

141 lines (112 loc) · 6.21 KB
Raw

CodeRabbit

CodeRabbit 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.

This curated list covers the best resources, tutorials, and community content related to CodeRabbit 🐰

Contents

Local setup

mkdir coderabbit
cd coderabbit
git init -b main
mkdir -p guidelines
cat > guidelines/block-plugin.md <<'DOC'
# WordPress block plugin guidelines

Use block.json as the canonical metadata source. Prefer Block API v3, use `useBlockProps()` on the edit root, keep strings translatable with `__()`, and sanitise and escape dynamic output in PHP render callbacks and REST endpoints.
DOC
cat > guidelines/block-theme.md <<'DOC'
# WordPress block theme guidelines

Use `theme.json` for global styles, keep templates composable and block-first, prefer native blocks and style variations, and enforce sanitisation, escaping, accessibility, and minimal front-end JavaScript.
DOC
git add guidelines
git commit -m "docs: add WordPress CodeRabbit guidelines"
git remote add origin https://github.com/lightspeedwp/coderabbit.git
git fetch origin
git branch -M main

The production fallback CodeRabbit configuration lives in .coderabbit.yaml.

Official Resources

  • Documentation - Comprehensive docs covering all aspects of CodeRabbit.
  • Blog - Official blog featuring updates, tutorials, and best practices.
  • FAQ - Frequently asked questions about CodeRabbit.
  • GitHub Repository - Official AI PR Reviewer repository.
  • LinkedIn - Official LinkedIn presence.
  • Twitter - Official Twitter/X account.
  • YouTube Channel - Official YouTube channel with tutorials and updates.

Getting Started

API Reference

Configuration Examples

Enterprise Configuration Example

Explore real-world CodeRabbit configurations from various projects.

# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
language: "en-US"
early_access: false
tone_instructions: '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.'
reviews:
  profile: "chill"
  request_changes_workflow: false
  high_level_summary: true
  poem: true
  review_status: true
  collapse_walkthrough: false
  auto_review:
    enabled: true
    drafts: false
    base_branches: ["pg", "release"]
  path_instructions:
    - path: "app/client/cypress/**/**.*"
      instructions: |
        Review the following e2e test code written using the Cypress test library. Ensure that:
        - Follow best practices for Cypress code and e2e automation
        - Avoid using cy.wait in code
        - Avoid using cy.pause in code
        - Avoid using agHelper.sleep()
        - Use locator variables for locators
        - Use data-* attributes for selectors
        - Avoid Xpaths, Attributes and CSS path
        - Avoid selectors like .btn.submit
        - Perform logins via API
        - Avoid using it.only
        - Use multiple assertions
        - Avoid string assertions
        - Ensure unique filenames
chat:
  auto_reply: true

Find more examples in the configs/ directory, organized by language:

configs/
├── javascript/   # JavaScript project configurations
├── typescript/   # TypeScript project configurations
├── python/       # Python project configurations
├── go/          # Go project configurations
└── multi-language/ # Full-stack project configurations

Pre-Merge Check Packs

The pre-merge check catalog contains copyable policy examples for common engineering risks, multi-tenant SaaS, fintech, and health tech. It explains how to select, adapt, and safely introduce individual checks without replacing existing repository configuration.

Integration Guides

Video Tutorials

Blogs