About repository settings
CodeRabbit provides three ways to manage its code-review behavior with each of your organization’s repositories:Configuration file
Add a
.coderabbit.yaml file to your repository for version-controlled settingsCentral configuration
Apply organization-wide settings that inherit to all repositories automatically
Web interface
View or modify your per-repository settings using the CodeRabbit dashboard
Configuration precedence
CodeRabbit applies settings in the following order:1
Repository YAML file (highest priority)
If your repository contains a
.coderabbit.yaml file at the top level of its default branch, CodeRabbit applies all settings from this file2
Repository web interface settings
If your repository doesn’t have a
.coderabbit.yaml file, CodeRabbit applies the configuration from the repository’s web interface settings3
Central configuration (organization-wide)
Settings from your organization’s central configuration are applied to repositories that don’t have repository-specific settings
4
Default values (lowest priority)
CodeRabbit applies its own default values to any configuration settings not defined elsewhere
Recommended approach: Use a
.coderabbit.yaml file as a best practice for version-controlled, team-visible configuration.Configure your repository with .coderabbit.yaml
To add configuration to your repository:
1
Get the template
2
Add to repository
Merge the
.coderabbit.yaml file to the top level of your default branch3
Customize settings
Update your repository’s CodeRabbit configuration by editing the
.coderabbit.yaml file like any other text fileLearn more about YAML configuration
Complete guide to adding and customizing configuration files
Browse and modify your settings using the web interface
To view or modify your repository settings using the CodeRabbit web interface:1
Open repository settings
Visit the CodeRabbit web interface and click Repositories in the sidebar
2
Select repository
Click the gear-shaped Settings icon of the repository whose settings you want to view or modify
3
Configure inheritance
If the Use Organization Settings toggle is on, click it to turn it off to customize this repository’s settings
If you leave the toggle on, CodeRabbit applies settings from the organization-configuration page to this repository
4
Apply changes
Browse and modify the settings as needed. Click Apply Changes when you are finished