Skip to content

Commit 051236d

Browse files
committed
update auto title
1 parent d484505 commit 051236d

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

docs/guides/configure-coderabbit.md

+13-5
Original file line numberDiff line numberDiff line change
@@ -65,13 +65,16 @@ YAML settings:
6565
- **`high_level_summary`**: CodeRabbit generates a high-level summary of the
6666
changes in the PR/MR description (default:`true`).
6767
- **`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`).
7072
- **`poem`**: Indicates whether a creative poem should be included in the
7173
review (default:`true`).
7274
- **`review_status`**: Include a review status when a review is skipped in
7375
certain cases (default:`true`).
74-
- **`collapse_walkthrough`**: Collapses the walkthrough comment (default:`false`).
76+
- **`collapse_walkthrough`**: Collapses the walkthrough comment
77+
(default:`false`).
7578
- **`path_filters`**: Specifies file patterns to exclude or include for a
7679
review, such as `!dist/**` and `src/**.tsx`, using glob notation. Example:
7780

@@ -155,11 +158,16 @@ YAML settings:
155158
- **`enabled`**: Enable integration, defaults to true.
156159
- **`swiftlint`**: Configuration for `swiftlint` integration.
157160
- **`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`.
159164
- **`phpstan`**: Configuration for `phpstan` integration.
160165
- **`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".
162169
- **`languagetool`**: Configuration for `languagetool` integration.
170+
163171
- **`enabled`**: Enable integration, defaults to true.
164172
- **`level`**: The level of the rule. It can be one `default` or `picky`.
165173
If set to `picky`, additional rules will be activated, i.e. rules that

0 commit comments

Comments
 (0)