Skip to content

Clarify several best practices. #389

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 12, 2025
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Tweaks
  • Loading branch information
jmacdotorg committed Jun 6, 2025
commit ea9a458ed5338ddaa3791b118330b9d3d9381642
4 changes: 2 additions & 2 deletions docs/guides/setup-best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,13 +65,13 @@ works with your individual repositories.
CodeRabbit gives you two ways to configure how it works with your team's repositories:

- The [Repositories](https://app.coderabbit.ai/settings/repositories) page of the
Dashboard
CodeRabbit web interface
- A [`coderabbit.yaml` file](/getting-started/configure-coderabbit/) in your repository

The Repositories page lets you set up your per-repository
preferences rapidly, and can help you get familiar with CodeRabbit configuration options.

We recommend adding a `coderabbit.yaml` file to repositories, as well. Using this file has several advantages over using only the Dashboard:
We recommend adding a `coderabbit.yaml` file to repositories, as well. Using this file has several advantages over using only the web interface:

- It applies version control to your repository's CodeRabbit settings, letting you track changes, view configuration history, and revert to previous configurations as needed.
- During code reviews, CodeRabbit loads the file along with rest of your repository. This means that you can include setting changes as part of a pull request, and CodeRabbit both analyzes and applies these settings during its review.
Expand Down