@@ -55,8 +55,8 @@ reviews:
5555 -" feat/.*"
5656tools :
5757ast-grep :
58- rules_folder :" custom-rules-folder -name"
59- utils_folder :" custom-utils-folder -name"
58+ rules_directory :" custom-rules-directory -name"
59+ utils_directory :" custom-utils-directory -name"
6060chat :
6161auto_reply :true
6262` ` `
@@ -70,47 +70,48 @@ repository.
7070
7171YAML settings :
7272
73- 1. **language** :Set the language for reviews using the ISO language code. For
73+ 1. **` language` ** :Set the language for reviews using the ISO language code. For
7474example, `"fr"` stands for French (default:`en`).
7575
76- 2. **early_access** :Enroll in the early access program to take advantage of
76+ 2. **` early_access` ** :Enroll in the early access program to take advantage of
7777forthcoming features before their general release (default:`false`).
7878
79- 3. **reviews** :Configurations for the code reviews.
80- - **request_changes_workflow**: EnableRequest Changes review workflow for
79+ 3. **` reviews` ** :Configurations for the code reviews.
80+ - **` request_changes_workflow` **: Enablerequest changes review workflow for
8181CodeRabbit reviews. (default :` false` ).
82- - **high_level_summary**: CodeRabbit generates a high
82+ - **` high_level_summary` **: CodeRabbit generates a high- level summary of the
8383changes (default:`true`).
84- - **poem**: Indicates whether a creative poem should be included in the
84+ - **` poem` **: Indicates whether a creative poem should be included in the
8585review (default:`true`).
86- - **review_status**: Indicates the status of the review (default:`true`).
87- - **collapse_walkthrough**: Collapses the walkthrough comment
86+ - **` review_status` **: Indicates the status of the review (default:`true`).
87+ - **` collapse_walkthrough` **: Collapses the walkthrough comment
8888(default:`false`).
89- - **path_filters**: Specifies file patterns to exclude or include for a
89+ - **` path_filters` **: Specifies file patterns to exclude or include for a
9090review, such as `!dist/**` and `src/**.tsx`, using glob notation.
91- - **path_instructions**: Provides specific additional guidelines for code
91+ - **` path_instructions` **: Provides specific additional guidelines for code
9292review based on file paths. In the given example, JavaScript files are
9393singled out for checks against the Google JavaScript style guide. File path
9494accepts glob pattern
95- - **auto_review**: Manages settings for automated code reviews, such as:
96- - **enabled**: Automated code review (default: `true`).
97- - **ignore_title_keywords**: Review will be ignored if a pull request title
98- contains one of the list of keywords (e.g., `"WIP"`, `"DO NOT MERGE"`).
99- - **labels**: Review will be triggered if a pull request contains one of
95+ - **`auto_review`**: Manages settings for automated code reviews, such as:
96+ - **`enabled`**: Automated code review (default: `true`).
97+ - **`ignore_title_keywords`**: Review will be ignored if a pull request
98+ title contains one of the list of keywords (e.g., `"WIP"`,
99+ ` "DO NOT MERGE"` ).
100+ - **`labels`**: Review will be triggered if a pull request contains one of
100101the list of labels.
101- - **drafts**: Determines whether draft pull requests are reviewed (default:
102- ` true` ).
103- - **base_branches**: A list of base branches where the reviews will occur
102+ - **` drafts` **: Determines whether draft pull requests are reviewed
103+ (default : ` true` ).
104+ - **` base_branches` **: A list of base branches where the reviews will occur
104105apart from the default branch. Accepts regex pattern.
105- - **tools**: Configurations for the tools used in the review.
106- - **ast-grep**: Configurations for the ast-grep tool.
107- - **rules_folder **: Thefolder name where the custom ast-grep rules are
108- stored.
109- - **utils_folder **: Thefolder name where the custom ast-grep utils are
110- stored.
111- 4. **chat** :Defines the behavior of CodeRabbit's bot in conversations.
112- - **auto_reply**: The bot automatically replies without the need of the user
113- tagging it (default :` true` ).
106+ - **` tools` **: Configurations for the tools used in the review.
107+ - **` ast-grep` **: Configurations for the` ast-grep` tool.
108+ - **`rules_directory` **: Thedirectory name where the custom` ast-grep`
109+ rules are stored.
110+ - **`utils_directory` **: Thedirectory name where the custom` ast-grep`
111+ utils are stored.
112+ 4. **` chat` ** :Defines the behavior of CodeRabbit's bot in conversations.
113+ - **` auto_reply` **: The bot automatically replies without the need of the
114+ user tagging it (default` true` ).
114115
115116Refer :
116117[CodeRabbit Configuration Schema](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json).
@@ -157,47 +158,45 @@ settings:
157158 tools:
158159 # tools configuration for ast-grep
159160 ast-grep:
160- rules_folder : "custom-rules-folder -name"
161- utils_folder : "custom-utils-folder -name"
161+ rules_directory : "custom-rules-directory -name"
162+ utils_directory : "custom-utils-directory -name"
162163` ` `
163164
164- <!--  -->
165-
166165This configuration file consists of the following settings :
167166
168- 1. **enable_draft_pr_reviews** :Set to **false** to disable draft pull
167+ 1. **` enable_draft_pr_reviews` ** :Set to **` false` ** to disable draft pull
169168request(PR) reviews.
170- 2. **additional_branches_to_be_reviewed** :Define additional branches to be
169+ 2. **` additional_branches_to_be_reviewed` ** :Define additional branches to be
171170reviewed besides the default branch.
172- 3. **disable_high_level_summary** :If set to **true**, disables high-level
171+ 3. **` disable_high_level_summary` ** :If set to **` true` **, disables high-level
173172summary generation.
174- 4. **path_based_instructions** :Allows you to specify instructions based on file
175- paths. In this example, instructions for Python and JavaScript files are
173+ 4. **` path_based_instructions` ** :Allows you to specify instructions based on
174+ file paths. In this example, instructions for Python and JavaScript files are
176175provided, encouraging adherence to the Google style guide.
177- 5. **ignored_pr_titles** :Specifies ignored PR titles, in this case, "WIP" (Work
178- in Progress).
179- 6. **review_language** :Sets the review language to French ("fr" ).
180- 7. **disable_poem** :If set to **false**, enables the "poem" feature.
181- 8. **early_access_program** :Determines whether to enable the early access
182- program (set to **false** in this case).
183- 9. **exclude_file_patterns** :Specifies patterns for excluding certain files
176+ 5. **` ignored_pr_titles` ** :Specifies ignored PR titles, in this case, "WIP"
177+ (Work in Progress).
178+ 6. **` review_language` ** :Sets the review language to French (`fr` ).
179+ 7. **` disable_poem` ** :If set to **` false` **, enables the "poem" feature.
180+ 8. **` early_access_program` ** :Determines whether to enable the early access
181+ program (set to **` false` ** in this case).
182+ 9. **` exclude_file_patterns` ** :Specifies patterns for excluding certain files
184183from review, such as `!dist/**` and `!**.md`.
185- 10. **limit_reviews_by_label** :Limits reviews by label, targeting "first_bug"
184+ 10. **` limit_reviews_by_label` ** :Limits reviews by label, targeting "first_bug"
186185label reviews.
187- 11. **disable_review** :Totally disables automatic code reviews for the
186+ 11. **` disable_review` ** :Totally disables automatic code reviews for the
188187repository.
189- 12. **disable_review_status** :This is the comment posted for each incremental
188+ 12. **` disable_review_status` ** :This is the comment posted for each incremental
190189review status. This removes the review status comment. Reviews will still
191190take place. However, optional comments added to the review status will not
192191be posted.
193- 13. **collapse_walkthrough_comment** :Specifies whether to collapse walkthrough
194- comments on the review.
195- 14. **tools** :Configurations for the tools used in the review.
196- - **ast-grep**: Configurations for the ast-grep tool.
197- - **rules_folder **: Thefolder name where the custom ast-grep rules are
198- stored.
199- - **utils_folder **: Thefolder name where the custom ast-grep utils are
200- stored.
192+ 13. **` collapse_walkthrough_comment` ** :Specifies whether to collapse
193+ walkthrough comments on the review.
194+ 14. **` tools` ** :Configurations for the tools used in the review.
195+ - **` ast-grep` **: Configurations for the` ast-grep` tool.
196+ - **`rules_directory` **: Thedirectory name where the custom` ast-grep`
197+ rules are stored.
198+ - **`utils_directory` **: Thedirectory name where the custom` ast-grep`
199+ utils are stored.
201200
202201Refer :
203202[CodeRabbit configuration schema](https://coderabbit.ai/integrations/coderabbit-overrides.json).
@@ -224,7 +223,7 @@ section [Prompt Customization](/guides/prompt-customization)
224223feedback. CodeRabbit supports most of the widely used languages. The default
225224language is English.
226225
227- **Disable High
226+ **Disable High- Level Summary:** This allows disabling high-level summary added
228227with the pull request description.
229228
230229---