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
{{ message }}
This repository was archived by the owner on Aug 16, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: docs/guides/configure-coderabbit.md
+13-5Lines changed: 13 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -65,13 +65,16 @@ YAML settings:
65
65
- **`high_level_summary`**: CodeRabbit generates a high-level summary of the
66
66
changes in the PR/MR description (default:`true`).
67
67
- **`high_level_summary_placeholder`**: Placeholder in the PR/MR description
68
-
that gets replaced with the high-level summary (default:`@coderabbitai summary`).
69
-
- **`auto_title_placeholder`**: Placeholder in the PR/MR title that gets replaced with an auto-generated title (default:`@coderabbitai title`).
68
+
that gets replaced with the high-level summary
69
+
(default:`@coderabbitai summary`).
70
+
- **`auto_title_placeholder`**: Add this keyword in the PR/MR title to
71
+
auto-generate the title. (default:`@coderabbitai`).
70
72
- **`poem`**: Indicates whether a creative poem should be included in the
71
73
review (default:`true`).
72
74
- **`review_status`**: Include a review status when a review is skipped in
73
75
certain cases (default:`true`).
74
-
- **`collapse_walkthrough`**: Collapses the walkthrough comment (default:`false`).
76
+
- **`collapse_walkthrough`**: Collapses the walkthrough comment
77
+
(default:`false`).
75
78
- **`path_filters`**: Specifies file patterns to exclude or include for a
76
79
review, such as `!dist/**` and `src/**.tsx`, using glob notation. Example:
77
80
@@ -155,11 +158,16 @@ YAML settings:
155
158
- **`enabled`**: Enable integration, defaults to true.
156
159
- **`swiftlint`**: Configuration for `swiftlint` integration.
157
160
- **`enabled`**: Enable integration, defaults to true.
158
-
- **`config_file`**: Path to the `swiftlint` configuration file relative to the repository. This is useful when the configuration file is named differently than the default `.swiftlint.yml` or `.swiftlint.yaml`.
161
+
- **`config_file`**: Path to the `swiftlint` configuration file relative
162
+
to the repository. This is useful when the configuration file is named
163
+
differently than the default `.swiftlint.yml` or `.swiftlint.yaml`.
159
164
- **`phpstan`**: Configuration for `phpstan` integration.
160
165
- **`enabled`**: Enable integration, defaults to true.
161
-
- **`level`**: The [rule level](https://phpstan.org/user-guide/rule-levels) to run. Default is "1".
166
+
- **`level`**: The
167
+
[rule level](https://phpstan.org/user-guide/rule-levels) to run.
168
+
Default is "1".
162
169
- **`languagetool`**: Configuration for `languagetool` integration.
170
+
163
171
- **`enabled`**: Enable integration, defaults to true.
164
172
- **`level`**: The level of the rule. It can be one `default` or `picky`.
165
173
If set to `picky`, additional rules will be activated, i.e. rules that