> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coderabbit.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Example configurations

> Copy a starter configuration for your stack, then adjust it for your team.

Each example is a complete, copyable configuration. Pick the closest one, adjust it, and add it to your repository as `.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

> [card] [React Native and Expo](https://docs.coderabbit.ai/configuration/examples/expo.md)
>
> Mobile configuration with Expo conventions, performance checks and accessibility guidance. Schema V2.

> [card] [Python and Django](https://docs.coderabbit.ai/configuration/examples/django.md)
>
> Web framework configuration for model validation, `QuerySet` performance and docstrings. Schema V2.

> [card] [Documentation site](https://docs.coderabbit.ai/configuration/examples/mintlify.md)
>
> Configuration for a Mintlify documentation repository, with path filters and instructions for MDX files. Schema V2.

The community collection `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.

| Label | What it means | First line of the file |
| - | - | - |
| Schema V2 | Works for every repository. The default schema | `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` |
| Schema V3 | Limited preview. Starts with `version: 3` | `version: 3` |

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](https://docs.coderabbit.ai/configuration/guides/migrate-to-v3.md).

## 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 sets `inheritance: 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](https://docs.coderabbit.ai/configuration/inheritance-and-merging.md).

```yaml .coderabbit.yaml theme={null}
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
language: "en-US"
reviews:
  profile: "chill"
  high_level_summary: true
  review_status: true
  collapse_walkthrough: true
  sequence_diagrams: true
  poem: false
  auto_review:
    enabled: true
    auto_incremental_review: true
    drafts: false
chat:
  auto_reply: true
```

The [configuration reference](https://docs.coderabbit.ai/reference/configuration.md) lists the default of every key.

## Enforce settings with global overrides

A global overrides document enforces its keys on every repository. This example sets the `assertive` profile and flags statements that drop or truncate tables.

```yaml theme={null}
reviews:
  profile: assertive
  path_instructions:
    - path: "**/*.sql"
      instructions: "Flag statements that drop or truncate tables."
```

Read [Global overrides](https://docs.coderabbit.ai/configuration/global-overrides.md) before you apply an override.

## 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 sets `inheritance: 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.

> [tab] YAML V2
>
> ```yaml .coderabbit.yaml theme={null}
> # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
> language: en-US
> inheritance: false
> reviews:
>   profile: assertive
>   path_filters:
>     - "!dist/**"
>   high_level_summary: true
>   high_level_summary_in_walkthrough: true
>   in_progress_fortune: false
>   auto_review:
>     enabled: true
>     drafts: false
> chat:
>   art: false
> ```

> [tab] YAML V3
>
> Early Access (This feature is in early access. Enable it by setting `early_access: true` in your `.coderabbit.yaml`, or by toggling Early Access on the web interface.)
>
> V3 is a limited preview. Adding `version: 3` doesn't give your organization access.
>
> ```yaml .coderabbit.yaml theme={null}
> version: 3
> language: en-US
> inheritance: false
> reviews:
>   behavior:
>     profile: assertive
>     path_filters:
>       - "!dist/**"
>   auto_review:
>     enabled: true
>     drafts: false
>   output:
>     summary:
>       placement: walkthrough
> fun:
>   art: false
>   in_progress_fortune: false
> ```

V3 has no `path_instructions` or custom checks in YAML. Write them as Markdown documents under `.coderabbit/instructions/` and `.coderabbit/pre-merge-checks/`. [Migrate configuration to V3](https://docs.coderabbit.ai/configuration/guides/migrate-to-v3.md#move-instructions-and-checks-into-documents) shows one of each, and [Instruction and check documents](https://docs.coderabbit.ai/configuration/documents.md) explains every field.

## Find examples on other pages

Some examples live next to the feature that explains them.

> [card] [TypeScript configuration](https://docs.coderabbit.ai/configuration/typescript.md)
>
> A minimal `defineConfig` file.

> [card] [Inheritance and merging](https://docs.coderabbit.ai/configuration/inheritance-and-merging.md)
>
> A repository file that overrides a central file.

> [card] [Global overrides](https://docs.coderabbit.ai/configuration/global-overrides.md)
>
> Overrides that every repository receives.

> [card] [Change one pull request](https://docs.coderabbit.ai/configuration/guides/one-pull-request.md)
>
> Per-review and pull request description overrides.

## What's next

> [card] [Configuration file](https://docs.coderabbit.ai/configuration/file.md)
>
> Learn where the file lives and how CodeRabbit reads it.

> [card] [Control when reviews run](https://docs.coderabbit.ai/pr-reviews/when-reviews-run.md)
>
> Tune the `auto_review` settings that most examples include.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.