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
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.
38
-
39
-
If you want to allow CodeRabbit to mark pull requests as approved, then you can enable the _request changes workflow_ setting. If you do, then CodeRabbit can approve pull requests after it reviewed a pull request and had all of its comments resolved.
40
-
41
-
This can be useful if you have a workflow that requires several reviewers to approve a pull request before anyone can merge it. For example, if you have configured your repository on your Git platform to require two approvals for any pull request, then activating this CodeRabbit setting lets you merge a pull request after approval from CodeRabbit plus one human reviewer. This can help reduce your team's code-review load.
42
-
43
-
:::note
44
-
We recommend a policy of always requiring the approval of at least one human reviewer, even if you allow CodeRabbit to approve pull requests. As with an generative AI technology, CodeRabbit works best as a helpful partner to your team, and not as a replacement for human expertise or judgment.
45
-
:::
46
-
47
-
For more information, see [Request Changes Workflow](/reference/configuration#request-changes-workflow) in the configuration reference.
You can [ask CodeRabbit to create issues for you](https://docs.coderabbit.ai/guides/issue-creation) in the comments of a pull request that it's reviewing.
52
-
53
-
If you have integrated CodeRabbit with Jira or Linear, then you can tune this behavior a little more, restricting this feature to private repositories—the default setting—or disabling it entirely.
54
-
55
-
For more information, see [Integrations](/reference/configuration#integrations) in the configuration reference.
56
-
57
35
### Configure learnings {#learnings}
58
36
59
-
You can teach CodeRabbit your team's review preferences by [stating them in plain language during code reviews](/integrations/knowledge-base#learnings). CodeRabbit remembers these these preferences, and applies them to subsequent code reviews in the same repository.
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.
60
38
61
39
If you don't want this feature, you can disable it. For more information, see [Learnings](/reference/configuration#learnings) in the configuration reference.
62
40
@@ -139,13 +117,8 @@ For example, to give CodeRabbit review instructions specific to JavaScript and T
139
117
140
118
```yaml
141
119
path_instructions:
142
-
- path: `src/**/*.{ts,tsx,js}`
143
-
instructions:
144
-
- Review the React.js, TypeScript, JavaScript code for best practices
145
-
- Check for common security vulnerabilities such as:
146
-
- SQL Injection
147
-
- Insecure dependencies
148
-
- Sensitive data exposure
120
+
- path: `src/**/*.{ts,tsx,js}`
121
+
instructions: "Review the React.js, TypeScript, JavaScript code for best practices. Check for common security vulnerabilities, such as SQL injection, insecure dependencies, and sensitive data exposure."
149
122
```
150
123
151
124
For more information, see [Path instructions](/reference/configuration#path-instructions) in the configuration reference.
@@ -201,6 +174,30 @@ reviews:
201
174
202
175
For more information, see [Tools](/reference/configuration#tools) 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.
182
+
183
+
If you want to allow CodeRabbit to mark pull requests as approved, then you can enable the _request changes workflow_ setting. If you do, then CodeRabbit can approve pull requests after it reviewed a pull request and had all of its comments resolved.
184
+
185
+
This can be useful if you have a workflow that requires several reviewers to approve a pull request before anyone can merge it. For example, if you have configured your repository on your Git platform to require two approvals for any pull request, then activating this CodeRabbit setting lets you merge a pull request after approval from CodeRabbit plus one human reviewer. This can help reduce your team's code-review load.
186
+
187
+
:::note
188
+
We recommend a policy of always requiring the approval of at least one human reviewer, even if you allow CodeRabbit to approve pull requests. As with an generative AI technology, CodeRabbit works best as a helpful partner to your team, and not as a replacement for human expertise or judgment.
189
+
:::
190
+
191
+
For more information, see [Request Changes Workflow](/reference/configuration#request-changes-workflow) in the configuration reference.
You can [ask CodeRabbit to create issues for you](https://docs.coderabbit.ai/guides/issue-creation) in the comments of a pull request that it's reviewing.
196
+
197
+
If you have integrated CodeRabbit with Jira or Linear, then you can tune this behavior a little more, restricting this feature to private repositories—the default setting—or disabling it entirely.
198
+
199
+
For more information, see [Integrations](/reference/configuration#integrations) in the configuration reference.
200
+
204
201
## What's next {#whats-next}
205
202
206
203
- [Setup and configuration best practices](/guides/setup-best-practices)
Copy file name to clipboardExpand all lines: docs/guides/organization-settings.md
+13-7Lines changed: 13 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -11,14 +11,14 @@ For a general overview of configuring CodeRabbit, see [Configure CodeRabbit](/gu
11
11
12
12
## About organization settings {#about}
13
13
14
-
You can use the CodeRabbit web interface to set the default CodeRabbit configuration
15
-
for all Git repositories associated with your organization. There are two reasons
16
-
to review and set your organizational settings:
14
+
You can use the CodeRabbit web interface to set a CodeRabbit configuration
15
+
for all Git repositories associated with your organization.
17
16
18
-
- When you give CodeRabbit access to a new repository, CodeRabbit applies all of your
19
-
organizational settings to that repository as defaults.
20
-
- Some settings, such as [Data retention](/reference/configuration#data-retention), apply only at the organizational level, with
21
-
no per-repository equivalent.
17
+
You
18
+
19
+
:::note
20
+
Some settings, such as [Data retention](/reference/configuration#data-retention), apply only at the organizational level, with no per-repository equivalent.
21
+
:::
22
22
23
23
## Browse and modify your organization settings {#modify}
24
24
@@ -28,6 +28,12 @@ To view or modify your organizational settings, follow these steps:
28
28
1. In the sidebar, click **Organization Settings** > **Configuration**.
29
29
1. Browse and modify the settings as needed. If you do make changes, click **Apply Changes** when you are finished.
30
30
31
+
## Apply organization settings to your repositories {#repositories}
32
+
33
+
To apply your organizational settings to a repository, follow these steps:
0 commit comments