-
Notifications
You must be signed in to change notification settings - Fork 170
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation for review request handling feature
- Loading branch information
1 parent
1ac039e
commit 794f117
Showing
2 changed files
with
25 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Review Requested | ||
|
||
This feature will automatically adjust the labels on a pull request when the PR author requests a review from an assignee. | ||
|
||
## Usage | ||
|
||
In the list of reviewers, click the "Re-request review" button near an assignee's name. | ||
This will automatically remove the "waiting on the author" labels, and add a new labels to indicate that the PR is waiting on the review. | ||
|
||
## Configuration | ||
|
||
This feature is enabled on a repository by having a `[review-requested]` table in `triagebot.toml`: | ||
|
||
```toml | ||
[review-requested] | ||
# Those labels are removed when PR author requests a review from an assignee | ||
remove_labels = ["S-waiting-on-author"] | ||
# Those labels are added when PR author requests a review from an assignee | ||
add_labels = ["S-waiting-on-review"] | ||
``` | ||
|
||
## Implementation | ||
|
||
See [`src/handlers/review_requested.rs`](https://github.com/rust-lang/triagebot/blob/HEAD/src/handlers/review_requested.rs). |