Skip to content

Add a new setup-and-configuration best practices guide. #385

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 7 commits into from
Jun 6, 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
Add a section about path filters.
  • Loading branch information
jmacdotorg committed Jun 6, 2025
commit bf7acaf47fddf9a4784e924ace22aac798a1df67
14 changes: 14 additions & 0 deletions docs/guides/setup-best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,20 @@ settings defned for that same repository in the Dashboard.

For more information, see [Add a configuration file](/getting-started/configure-coderabbit/).

### Speed up reviews by adding path filters {#filters}

If your repository contains a lot of data or other content that CodeRabbit
doesn't need for code review context, then you can include _path filters_ in
your repository configuration. For example, a filter of `!dist/**` tells CodeRabbit
to disregard everything in your reposistory's top-level `dist` directory when
preparing a code review.

Reducing the number of contextual files that CodeRabbit needs to read and analyze
when preparing a code review can help make its code reviews faster.

You can define path filters using the CodeRabbit
web interface, or with [a configuration file](/getting-started/configure-coderabbit/).
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Be consistent between the use of graphical UI or CR web interface and also a config file or coderabbit.yaml file


### Trust the defaults {#defaults}

CodeRabbit gives you control over a number of its core code-review features, letting you deactivate them entirely for your repositories if needed. We have chosen the default settings to meet the needs of most organizations and situations, and recommend leaving these settings at their default values if possible:
Expand Down