.coderabbit.yaml, or paste it into the YAML editor in the web interface. Every example states its schema version and links to the pages that explain the keys it uses.
Choose a starter configuration
React Native and Expo
Mobile configuration with Expo conventions, performance checks and accessibility guidance. Schema V2.
Python and Django
Web framework configuration for model validation,
QuerySet performance and docstrings. Schema V2.Documentation site
Configuration for a Mintlify documentation repository, with path filters and instructions for MDX files. Schema V2.
awesome-coderabbit on GitHub has more configurations for other stacks.
Check the version label
Every example states the schema version it uses, in its introduction and in its first line.
When an example exists in both versions, the page shows the two in tabs titled YAML V2 and YAML V3. V3 keys and file layout differ from V2, so you cannot reuse a V2 example as a V3 file. See Migrate configuration to V3.
Start from the defaults
This file sets common keys to their schema defaults, so you can see what CodeRabbit does when nothing changes them. Use it as a starting point and change only the values you want to differ. A repository file replaces your organizationâs settings unless it setsinheritance: true, and even then every key in the file wins over the organizationâs value, including keys you left at the default. To keep your organizationâs settings, set inheritance: true and add only the keys you want to change. Every layer between the file and your organizationâs settings, such as central configuration, must turn on inheritance too, because the walk stops after the first layer that doesnât. See Inheritance and merging.
.coderabbit.yaml
Enforce settings with global overrides
A global overrides document enforces its keys on every repository. This example sets theassertive profile and flags statements that drop or truncate tables.
Use V3 and directory documents
The same settings in both schemas: an assertive profile, a path filter, automatic reviews that skip drafts, the summary in the walkthrough, and no art or in-progress fortunes. The V3 file setsinheritance: false, so omitted fields use V3 defaults instead of parent settings. Settings the files leave out follow the defaults of each schema, which can differ: V2 adds sequence diagrams by default, and V3 doesnât.
- YAML V2
- YAML V3
.coderabbit.yaml
path_instructions or custom checks in YAML. Write them as Markdown documents under .coderabbit/instructions/ and .coderabbit/pre-merge-checks/. Migrate configuration to V3 shows one of each, and Instruction and check documents explains every field.
Find examples on other pages
Some examples live next to the feature that explains them.TypeScript configuration
A minimal
defineConfig file.Inheritance and merging
A repository file that overrides a central file.
Global overrides
Overrides that every repository receives.
Change one pull request
Per-review and pull request description overrides.
Whatâs next
Configuration file
Learn where the file lives and how CodeRabbit reads it.
Control when reviews run
Tune the
auto_review settings that most examples include.