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.

Sign up for GitHub

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

Clarify several best practices. #389

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1990034
Clarify several best practices.
jmacdotorg Jun 6, 2025
ea9a458
Tweaks
jmacdotorg Jun 6, 2025
a17241b
Clarify that the web UI covers both organization and repository prefe…
jmacdotorg Jun 11, 2025
b1678e7
Merge branch 'main' into best-practices
jmacdotorg Jun 11, 2025
6d4ae5c
Merge branch 'main' into best-practices
jmacdotorg Jun 12, 2025
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
Clarify that the web UI covers both organization and repository prefe… 
…rences.
  • Loading branch information
@jmacdotorg
jmacdotorg committed Jun 11, 2025
commit a17241b15a88fbaebc9c380ec6ac373f06dac985
6 changes: 3 additions & 3 deletions docs/guides/setup-best-practices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,11 @@ 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
CodeRabbit web interface
- The **Organization Settings** and **Repositories** pages of [the
CodeRabbit web interface](https://app.coderabbit.ai/login)
- A [`coderabbit.yaml` file](/getting-started/configure-coderabbit/) in your repository

The Repositories page lets you set up your per-repository
The web interface lets you set up your organization's code review
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 web interface:
Expand Down