You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/guides/setup-best-practices.md
+10-12Lines changed: 10 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -64,23 +64,21 @@ works with your individual repositories.
64
64
65
65
CodeRabbit gives you two ways to configure how it works with your team's repositories:
66
66
67
-
- The [Repositories](https://app.coderabbit.ai/settings/repositories) page of the
68
-
Dashboard
67
+
- The **Organization Settings** and **Repositories** pages of [the
68
+
CodeRabbit web interface](https://app.coderabbit.ai/login)
69
69
- A [`coderabbit.yaml` file](/getting-started/configure-coderabbit/) in your repository
70
70
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 web interface lets you set up your organization's code review
72
+
preferences rapidly, and can help you get familiar with CodeRabbit configuration options.
73
73
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 web interface:
77
75
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.
79
77
- 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.
80
78
- The file makes the repository's CodeRabbit settings transparent to all of the repository's contributors.
81
79
82
80
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.
84
82
85
83
For more information, see [Add a configuration file](/getting-started/configure-coderabbit/).
86
84
@@ -89,14 +87,14 @@ For more information, see [Add a configuration file](/getting-started/configure-
89
87
If your repository contains a lot of data or other content that CodeRabbit
90
88
doesn't need for code review context, then you can include _path filters_ in
91
89
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
93
91
preparing a code review.
94
92
95
93
Reducing the number of contextual files that CodeRabbit needs to read and analyze
96
94
when preparing a code review can help make its code reviews faster.
97
95
98
96
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/).
100
98
101
99
### Trust the defaults {#defaults}
102
100
@@ -108,7 +106,7 @@ CodeRabbit gives you control over a number of its core code-review features, let
108
106
tools](/tools) that are available to it during code reviews. This helps CodeRabbit keep its reviews broad and flexible.
109
107
-**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.
110
108
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/).
112
110
113
111
### Write specific CI/CD error messages {#pipeline}
0 commit comments