Skip to main content

Set your repository preferences

This page is about managing the settings of CodeRabbit for your Git repository. For a general overview of configuring CodeRabbit, see Configure CodeRabbit.

About repository settings​

CodeRabbit provides two ways to manage its code-review behavior with each of your organization's repositories:

  • Add a .coderabbit.yaml file to your repository.
  • View or modify your per-repository settings using the CodeRabbit web interface.

If your repository contains a .coderabbit.yaml file at the top level of its default branch, then CodeRabbit applies all of its settings to that repository's code reviews. CodeRabbit applies its own default values to any configuration settings not defined by your .coderabbit.yaml file.

If your repository doesn't have a .coderabbit.yaml file, then CodeRabbit applies the configuration from the CodeRabbit web interface, instead.

While the web interface provides an easier way to explore the available configuration options for your repository, we recommend using a .coderabbit.yaml file as a best practice.

Configure your repository with .coderabbit.yaml​

To add a .coderabbit.yaml file to your repository, merge a copy of our template configuration file to the top level of your default branch. From there, you can update your repository's CodeRabbit configuration by updating the .coderabbit.yaml file exactly as you would any other text file in your repository.

For more information about the .coderabbit.yaml file, see Add a configuration file.

Browse and modify your settings using the web interface​

To view or modify your repository settings using the CodeRabbit web interface, follow these steps:

  1. Visit the CodeRabbit web interface.
  2. In the sidebar, click Repositories.
  3. Click the gear-shaped Settings icon of the repository whose settings you want to view or modify.
  4. If the Use Organization Settings toggle is on, then click it to turn it off. If you leave it on, then CodeRabbit applies the settings you have set through the organization-configuration page to this repository.
  5. Browse and modify the settings as needed. If you do make changes, click Apply Changes when you are finished.

What's next​