Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 1990034

Browse files
committed
Clarify several best practices.
1 parent e4ebaaa commit 1990034

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

docs/guides/setup-best-practices.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -68,19 +68,17 @@ CodeRabbit gives you two ways to configure how it works with your team's reposit
6868
Dashboard
6969
- A [`coderabbit.yaml` file](/getting-started/configure-coderabbit/) in your repository
7070

71-
The graphical UI of the Repositories page lets you set up your per-repository
72-
preferences more rapidly, and can help you get familiar with CodeRabbit configuration options.
71+
The Repositories page lets you set up your per-repository
72+
preferences rapidly, and can help you get familiar with CodeRabbit configuration options.
7373

74-
Once you are ready to fine-tune the ways that CodeRabbit works with your repositories,
75-
we recommend adding a `coderabbit.yaml` file to each one. This file has several
76-
advantages over using only the Dashboard:
74+
We recommend adding a `coderabbit.yaml` file to repositories, as well. Using this file has several advantages over using only the Dashboard:
7775

78-
- It applies version control to your repository's CodeRabbit settings.
76+
- It applies version control to your repository's CodeRabbit settings, letting you track changes, view configuration history, and revert to previous configurations as needed.
7977
- 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.
8078
- The file makes the repository's CodeRabbit settings transparent to all of the repository's contributors.
8179

8280
Repository-level settings defined by a `coderabbit.yaml` take precedence over the
83-
settings defined for that repository in the Dashboard.
81+
settings defined for that repository or for your organization using the CodeRabbit web interface.
8482

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

@@ -89,14 +87,14 @@ For more information, see [Add a configuration file](/getting-started/configure-
8987
If your repository contains a lot of data or other content that CodeRabbit
9088
doesn't need for code review context, then you can include _path filters_ in
9189
your repository configuration. For example, a filter of `!dist/**` tells CodeRabbit
92-
to disregard everything in your reposistory's top-level `dist` directory when
90+
to disregard everything in your repository's top-level `dist` directory when
9391
preparing a code review.
9492

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

9896
You can define path filters using the CodeRabbit
99-
web interface, or with [a configuration file](/getting-started/configure-coderabbit/).
97+
web interface, or with [a `coderabbit.yaml` file](/getting-started/configure-coderabbit/).
10098

10199
### Trust the defaults {#defaults}
102100

@@ -108,7 +106,7 @@ CodeRabbit gives you control over a number of its core code-review features, let
108106
tools](/tools) that are available to it during code reviews. This helps CodeRabbit keep its reviews broad and flexible.
109107
- **Knowledge base**: CodeRabbit [knowledge base](/integrations/knowledge-base/) features, including learnings and issue tracking, can require data retention. If your organization needs to meet stricter data-retention policies, then you can opt out of using these features.
110108

111-
You can configure your use of the above features using the CodeRabbit web interface, or [a configuration file](/getting-started/configure-coderabbit/).
109+
You can configure your use of the above features using the CodeRabbit web interface, or [a `coderabbit.yaml` file](/getting-started/configure-coderabbit/).
112110

113111
### Write specific CI/CD error messages {#pipeline}
114112

0 commit comments

Comments
 (0)