Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings
This repository was archived by the owner on Aug 16, 2025. It is now read-only.

Commit477e459

Browse files
committed
improve config docs
1 parent626b626 commit477e459

File tree

1 file changed

+46
-40
lines changed

1 file changed

+46
-40
lines changed

‎docs/guides/configure-coderabbit.md‎

Lines changed: 46 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,10 @@ YAML settings:
7373
review, such as `!dist/**` and `src/**.tsx`, using glob notation. Example:
7474

7575
```yaml
76-
path_filters:
77-
- "!**/*.xml"
78-
- "!**/generated/**"
76+
reviews:
77+
path_filters:
78+
- "!**/*.xml"
79+
- "!**/generated/**"
7980
```
8081

8182
- **`path_instructions`**: Provides specific additional guidelines for code
@@ -84,16 +85,17 @@ YAML settings:
8485
accepts glob pattern. Example:
8586

8687
```yaml
87-
path_instructions:
88-
- path: "**/*.js"
89-
instructions:
90-
"Review the JavaScript code for conformity with the Google JavaScript
91-
style guide, highlighting any deviations."
92-
- path: "tests/**/*"
93-
instructions:
94-
"Assess the unit test code employing the Mocha testing framework.
95-
Test descriptions must be sufficiently detailed to clarify the
96-
purpose of each test."
88+
reviews:
89+
path_instructions:
90+
- path: "**/*.js"
91+
instructions:
92+
"Review the JavaScript code for conformity with the Google
93+
JavaScript style guide, highlighting any deviations."
94+
- path: "tests/**/*"
95+
instructions:
96+
"Assess the unit test code employing the Mocha testing framework.
97+
Test descriptions must be sufficiently detailed to clarify the
98+
purpose of each test."
9799
```
98100

99101
- **`auto_review`**: Manages settings for automated code reviews.
@@ -110,9 +112,11 @@ YAML settings:
110112
trigger, apart from the default branch. Accepts regex pattern. Example:
111113

112114
```yaml
113-
base_branches:
114-
- develop
115-
- feat/.*
115+
reviews:
116+
auto_review:
117+
base_branches:
118+
- develop
119+
- feat/.*
116120
```
117121

118122
- **`tools`**: Configures external tools integration settings.
@@ -154,30 +158,32 @@ YAML settings:
154158
specified with `enabled_rules` or `enabled_categories` are enabled.
155159

156160
```yaml
157-
ast-grep:
158-
rule_dirs:
159-
- "rules"
160-
util_dirs:
161-
- "utils"
162-
essential_rules: true
163-
packages:
164-
- "my-awesome-org/my-awesome-package" # public GitHub repository that contains ast-grep rules
165-
github-checks:
166-
enabled: true
167-
timeout_ms: 90000
168-
markdownlint:
169-
enabled: true
170-
ruff:
171-
enabled: true
172-
shellcheck:
173-
enabled: true
174-
languagetool:
175-
enabled: true
176-
enabled_only: false
177-
level: default
178-
enabled_categories:
179-
- "TON_ACADEMIC"
180-
- "CASING"
161+
reviews:
162+
tools:
163+
ast-grep:
164+
rule_dirs:
165+
- "rules"
166+
util_dirs:
167+
- "utils"
168+
essential_rules: true
169+
packages:
170+
- "my-awesome-org/my-awesome-package" # public GitHub repository that contains ast-grep rules
171+
github-checks:
172+
enabled: true
173+
timeout_ms: 90000
174+
markdownlint:
175+
enabled: true
176+
ruff:
177+
enabled: true
178+
shellcheck:
179+
enabled: true
180+
languagetool:
181+
enabled: true
182+
enabled_only: false
183+
level: default
184+
enabled_categories:
185+
- "TON_ACADEMIC"
186+
- "CASING"
181187
```
182188

183189
5. **`knowledge_base`**:Configures knowledge base settings.

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp