1
1
---
2
- title : Customize CodeRabbit
3
- sidebar_label : Customize CodeRabbit
2
+ title : Configure CodeRabbit
3
+ sidebar_label : Configure CodeRabbit
4
4
description :
5
- CodeRabbit offers various customization options to tailor the reviews to your
6
- specific requirements. Customizations can be made using one of the below
5
+ CodeRabbit offers various configuration options to tailor the reviews to your
6
+ specific requirements. Configuration can be made using one of the below
7
7
options.
8
8
---
9
9
10
- CodeRabbit offers various customization options to tailor the reviews to your
11
- requirements. Customizations can be made using one of the below options :
10
+ CodeRabbit offers various configuration options to tailor the reviews to your
11
+ requirements. Configuration can be made using one of the below options :
12
12
13
- 1 . ** Customization via CodeRabbit YAML File** _ (Recommended)_
14
- 2 . ** Customization via CodeRabbit UI**
13
+ 1 . ** Configure using CodeRabbit YAML File** _ (Recommended)_
14
+ 2 . ** Configure using CodeRabbit UI**
15
15
16
- Customization defined in the YAML file overrides the settings in the UI.
16
+ Configuration defined in the YAML file overrides the settings in the UI.
17
17
18
- ### 1. Customize CodeRabbit using a YAML File[ ] ( https://coderabbit.ai/docs/get-started/customize-coderabbit )
18
+ ### 1. Configure CodeRabbit using a YAML File {#yaml}
19
19
20
- You can add a ` .coderabbit.yaml ` configuration file to your repositories. Below
21
- is a sample YAML file that can be used as a starting point and changed as
22
- needed:
20
+ You can add a ` .coderabbit.yaml ` configuration file to root of your
21
+ repositories. Below is a sample YAML file that can be used as a starting point
22
+ and changed as needed:
23
23
24
24
#### version 2: ` Current `
25
25
@@ -55,24 +55,17 @@ reviews:
55
55
- " feat/.*"
56
56
tools :
57
57
ast-grep :
58
- rule_dirs :
58
+ rule_dirs :
59
59
- " rules"
60
- util_dirs :
60
+ util_dirs :
61
61
- " utils"
62
62
packages :
63
63
- " ast-grep-essentials"
64
- - " my-awesome-org/my-awesome-package" # public repository that contains ast-grep
64
+ - " my-awesome-org/my-awesome-package" # public GitHub repository that contains ast-grep rules
65
65
chat :
66
66
auto_reply : true
67
67
` ` `
68
68
69
- :::note
70
-
71
- ` .coderabbit.yaml` file should be placed in the root directory of the
72
- repository.
73
-
74
- :: :
75
-
76
69
YAML settings:
77
70
78
71
1. **` language`**: Set the language for reviews using the ISO language code. For
@@ -110,11 +103,12 @@ YAML settings:
110
103
apart from the default branch. Accepts regex pattern.
111
104
- **`tools`**: Configurations for the tools used in the review.
112
105
- **`ast-grep`**: Configurations for the `ast-grep` tool.
113
- - **`rule_dirs`**: The directory name where the custom `ast-grep`
114
- rules are stored.
115
- - **`util_dirs`**: The directory name where the custom `ast-grep`
116
- utils are stored.
117
- - **`packages`**: A package allows you to share rules across multiple projects. Essentially, a package is a collection of `ast-grep` rules.
106
+ - **`rule_dirs`**: The directory name where the custom `ast-grep` rules
107
+ are stored.
108
+ - **`util_dirs`**: The directory name where the custom `ast-grep` utils
109
+ are stored.
110
+ - **`packages`**: A package allows you to share rules across multiple
111
+ projects. Essentially, a package is a collection of `ast-grep` rules.
118
112
4. **`chat`** : Defines the behavior of CodeRabbit's bot in conversations.
119
113
- **`auto_reply`**: The bot automatically replies without the need of the
120
114
user tagging it (default : ` true` ).
@@ -126,7 +120,7 @@ Refer:
126
120
127
121
<summary> version 1 (deprecated) </summary>
128
122
129
- # ### version 1: `deprecated` (Please use version [version 2](/guides/customize-coderabbit ))
123
+ # ### version 1: `deprecated` (Please use version [version 2](#yaml ))
130
124
131
125
` ` ` yaml
132
126
settings:
@@ -161,7 +155,6 @@ settings:
161
155
# Disable automatic code reviews for this repository.
162
156
disable_review: false
163
157
# External tools configurations
164
-
165
158
` ` `
166
159
167
160
This configuration file consists of the following settings :
@@ -194,27 +187,26 @@ This configuration file consists of the following settings:
194
187
13. **`collapse_walkthrough_comment`** : Specifies whether to collapse
195
188
walkthrough comments on the review.
196
189
197
-
198
190
Refer :
199
191
[CodeRabbit configuration schema](https://coderabbit.ai/integrations/coderabbit-overrides.json).
200
192
201
193
</details>
202
194
203
- # ## 2. Customize CodeRabbit through the UI [](https://coderabbit.ai/docs/get-started#2-customize-coderabbit-through-the-ui-dashboard)
195
+ # ## 2. Configure CodeRabbit through the UI
204
196
205
- Reviews can also be customized through the UI under repository settings :
197
+ Reviews can also be configured through the UI under repository settings :
206
198
207
199
---
208
200
209
- # ## Review Customization[](https://coderabbit.ai/docs/get-started#review-customization)
201
+ # ## Review Configuration
210
202
211
203
[](../get-started/images/tailor2.png)
212
204
213
205
**Path-based instructions :** Provide additional review guidelines based on the
214
206
file paths using glob patterns.
215
207
216
208
For further guidance, please refer to this
217
- section [Prompt Customization ](/guides/prompt-customization )
209
+ section [Prompt Configuration ](/guides/prompt-configuration )
218
210
219
211
**Language Selection:** Select the natural language in which you want the review
220
212
feedback. CodeRabbit supports most of the widely used languages. The default
@@ -225,7 +217,7 @@ added with the pull request description.
225
217
226
218
---
227
219
228
- # ## Review Filters [](https://coderabbit.ai/docs/get-started#review-filters)
220
+ # ## Review Filters
229
221
230
222
[](../get-started/images/tailor3.png)
231
223
0 commit comments