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/initial-configuration.md
+16-20Lines changed: 16 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -20,25 +20,7 @@ for a while, when you feel ready to customize its behavior.
20
20
21
21
Each section in the guide links to specific entries in the configuration reference. Each entry in the linked reference specifies the location of its configuration setting, in either the CodeRabbit web UI or your `.coderabbit.yaml` file.
22
22
23
-
## General settings {#general}
24
-
25
-
These settings adjust overall CodeRabbit code review behavior.
26
-
27
-
### Adjust code-review strictness {#profile}
28
-
29
-
If you want CodeRabbit to apply a much stricter and more nitpicky stance to its code reviews, then you can switch its _profile_ setting from `chill` to `assertive`.
30
-
31
-
CodeRabbit is aware of nitpickier output from the linters and other tools that it applies to code reviews, but includes less of it in its own review comments when the profile is set to `chill`. To have CodeRabbit include more nitpicky tool output in reviews, use the `assertive` profile.
32
-
33
-
For more information, see [Profile](/reference/configuration#profile) in the configuration reference.
34
-
35
-
### Configure learnings {#learnings}
36
-
37
-
By default, CodeRabbit learns your team's review preferences by letting you [teach it your preferences in plain language during code reviews](/integrations/knowledge-base#learnings). CodeRabbit remembers these preferences, and applies them to subsequent code reviews in the same repository.
38
-
39
-
If you don't want this feature, you can disable it. For more information, see [Learnings](/reference/configuration#learnings) in the configuration reference.
40
-
41
-
## Data retention settings {#data-retention}
23
+
## Data retention and knowledge base settings {#data-retention}
42
24
43
25
These settings help you control how much data about your code that CodeRabbit retains.
44
26
CodeRabbit temporarily stores information about your repositories in order to tailored reviews more quickly and better tailored to your team's needs. You can opt of these features if your organization has stricter data-retention policies.
@@ -68,11 +50,17 @@ For more information, see
68
50
69
51
### Configure knowledge base retention {#opt-out}
70
52
71
-
By default, CodeRabbit keeps its own [_knowledge base_](/integrations/knowledge-base): a store of metadata about your repositories, your team's history of pull requests, linked issues, and [learnings] about how CodeRabbit should tailor its own review behavior to best serve your team. If this long-term knowledge base storage conflicts with your organization's data-retention policies, then you can disable this feature.
53
+
By default, CodeRabbit keeps its own [_knowledge base_](/integrations/knowledge-base): a store of metadata about your repositories, your team's history of pull requests, linked issues, and learnings about how CodeRabbit should tailor its own review behavior to best serve your team. If this long-term knowledge base storage conflicts with your organization's data-retention policies, then you can disable this feature.
72
54
73
55
For more information, see
74
56
[Opt out](/reference/configuration#opt-out) in the configuration reference.
75
57
58
+
### Configure learnings {#learnings}
59
+
60
+
CodeRabbit learns your team's review preferences by letting you [teach it your preferences in plain language during code reviews](/integrations/knowledge-base#learnings). CodeRabbit remembers these preferences, and applies them to subsequent code reviews in the same repository.
61
+
62
+
This setting lets you set the scope of which stored learnings that CodeRabbit should apply to its code reviews. For more information, see [Learnings](/reference/configuration#learnings) in the configuration reference.
63
+
76
64
## Tune the length of code reviews {#content}
77
65
78
66
By default, CodeRabbit writes thorough code reviews with several sub-sections. If you'd rather have CodeRabbit generated shorter reviews then you can change some of the following settings:
@@ -176,6 +164,14 @@ For more information, see [Tools](/reference/configuration#tools) in the configu
176
164
177
165
## Other code review settings {#other}
178
166
167
+
### Adjust code-review strictness {#profile}
168
+
169
+
If you want CodeRabbit to apply a much stricter and more nitpicky stance to its code reviews, then you can switch its _profile_ setting from `chill` to `assertive`.
170
+
171
+
CodeRabbit is aware of nitpickier output from the linters and other tools that it applies to code reviews, but includes less of it in its own review comments when the profile is set to `chill`. To have CodeRabbit include more nitpicky tool output in reviews, use the `assertive` profile.
172
+
173
+
For more information, see [Profile](/reference/configuration#profile) in the configuration reference.
By default, CodeRabbit doesn't mark pull requests as approved after any code review, even if CodeRabbit doesn't have any further significant changes to suggest. This leaves the job of formal pull request approval entirely up to human reviewers.
Copy file name to clipboardExpand all lines: docs/guides/repository-settings.md
+4-2Lines changed: 4 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -22,8 +22,10 @@ While the web interface provides an easier way to explore the available configur
22
22
23
23
## Configure your repository with `.coderabbit.yaml`
24
24
25
-
For more information about creating and updating a `.coderabbit.yaml` file in
26
-
your repository, see [Add a configuration file](/getting-started/configure-coderabbit).
25
+
To add a `.coderabbit.yaml` file to your repository, merge a copy of [our template configuration file](/reference/yaml-template)
26
+
to the top level of your default branch. From there, you can update your repository's CodeRabbit configuration by updating the `.coderabbit.yaml` file exactly as you would any other text file in your repository.
27
+
28
+
For more information about the `.coderabbit.yaml` file, see [Add a configuration file](/getting-started/configure-coderabbit).
27
29
28
30
## Browse and modify your settings using the web interface {#modify}
0 commit comments