|
| 1 | +--- |
| 2 | +title:Configure CodeRabbit |
| 3 | +sidebar_label:Configure CodeRabbit |
| 4 | +description: |
| 5 | +CodeRabbit offers various configuration options to tailor the reviews to your |
| 6 | +specific requirements. Configuration can be made using one of the below |
| 7 | +options. |
| 8 | +sidebar_position:2 |
| 9 | +--- |
| 10 | + |
| 11 | +importSchemaViewerfrom"@site/src/components/SchemaViewer"; |
| 12 | + |
| 13 | +CodeRabbit offers various configuration options to tailor the reviews to your |
| 14 | +requirements. Configuration can be made using one of the below options, in order |
| 15 | +of precedence: |
| 16 | + |
| 17 | +1. Configure using CodeRabbit YAML file |
| 18 | +2. Configure using CodeRabbit UI for each repository |
| 19 | +3. Configure using CodeRabbit UI for the organization |
| 20 | + |
| 21 | +In this guide, we will cover the configuration using a YAML file. |
| 22 | + |
| 23 | +##Configure CodeRabbit using a YAML File |
| 24 | + |
| 25 | +You can add a`.coderabbit.yaml` configuration file to the root of your |
| 26 | +repositories. Below is a sample YAML file that can be used as a starting point |
| 27 | +and changed as needed: |
| 28 | + |
| 29 | +<SchemaViewer /> |
| 30 | + |
| 31 | +Refer: |
| 32 | +[CodeRabbit Configuration Schema](https://coderabbit.ai/integrations/schema.v2.json). |
| 33 | + |
| 34 | +Please note that code reviews commence with new pull requests or incremental |
| 35 | +commits to existing pull requests once the CodeRabbit app is installed. Should |
| 36 | +you have any questions or require assistance, our support team is here to help. |