Skip to content

Commit bf7acaf

Browse files
committed
Add a section about path filters.
1 parent 9582038 commit bf7acaf

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/guides/setup-best-practices.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,20 @@ settings defned for that same repository in the Dashboard.
8484

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

87+
### Speed up reviews by adding path filters {#filters}
88+
89+
If your repository contains a lot of data or other content that CodeRabbit
90+
doesn't need for code review context, then you can include _path filters_ in
91+
your repository configuration. For example, a filter of `!dist/**` tells CodeRabbit
92+
to disregard everything in your reposistory's top-level `dist` directory when
93+
preparing a code review.
94+
95+
Reducing the number of contextual files that CodeRabbit needs to read and analyze
96+
when preparing a code review can help make its code reviews faster.
97+
98+
You can define path filters using the CodeRabbit
99+
web interface, or with [a configuration file](/getting-started/configure-coderabbit/).
100+
87101
### Trust the defaults {#defaults}
88102

89103
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:

0 commit comments

Comments
 (0)