Skip to content

Commit 2bed02a

Browse files
committed
update docs
1 parent ff69ede commit 2bed02a

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

docs/guides/configure-coderabbit.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,11 @@ YAML settings:
4747
4848
1. **`language`**: Set the language for reviews using the ISO language code. For
4949
example, `"ja"` configures reviews in Japanese.
50-
2. **`early_access`**: Enroll in the early access program to take advantage of
50+
2. **`tone_instructions`**: Set the tone for the reviews and the chat. Example:
51+
'You must use talk like Mr. T. I pity the fool who doesn't!'
52+
3. **`early_access`**: Enroll in the early access program to take advantage of
5153
forthcoming features before their general release (default:`false`).
52-
3. **`reviews`**: Configurations for the code reviews.
54+
4. **`reviews`**: Configurations for the code reviews.
5355

5456
- **`request_changes_workflow`**: Enable request changes review workflow for
5557
CodeRabbit reviews. (default: `false`).
@@ -88,14 +90,14 @@ YAML settings:
8890
- **`auto_review`**: Manages settings for automated code reviews, such as:
8991
- **`enabled`**: Automated code review (default: `true`).
9092
- **`ignore_title_keywords`**: Review will be ignored if a pull request
91-
title contains one of the list of keywords (e.g., `"WIP"`,
92-
`"DO NOT MERGE"`).
93-
- **`labels`**: Review will be triggered if a pull request contains one of
94-
the list of labels.
93+
title contains one of the list of keywords (case-insensitive). Example:
94+
`"WIP"`, `"DO NOT MERGE"`.
95+
- **`labels`**: Review will be triggered if a pull request matches one of
96+
the list of labels (case-insensitive).
9597
- **`drafts`**: Determines whether draft pull requests are reviewed
9698
(default: `true`).
97-
- **`base_branches`**: A list of base branches where the reviews will occur
98-
apart from the default branch. Accepts regex pattern. Example:
99+
- **`base_branches`**: A list of base branches for which the reviews will
100+
trigger, apart from the default branch. Accepts regex pattern. Example:
99101
```yaml
100102
base_branches:
101103
- "develop"
@@ -121,7 +123,7 @@ YAML settings:
121123
- "my-awesome-org/my-awesome-package" # public GitHub repository that contains ast-grep rules
122124
```
123125

124-
4. **`chat`**: Defines the behavior of CodeRabbit's bot in conversations.
126+
5. **`chat`**: Defines the behavior of CodeRabbit's bot in conversations.
125127
- **`auto_reply`**: The bot automatically replies without the need of the
126128
user tagging it (default: `true`).
127129

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy