Skip to content

Commit 794f117

Browse files
WaffleLapkinMark-Simulacrum
authored andcommitted
Add documentation for review request handling feature
1 parent 1ac039e commit 794f117

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
- [Pinging](./triagebot/pinging.md)
2929
- [Requesting Prioritization](./triagebot/requesting-prioritization.md)
3030
- [Review Changes Requested](./triagebot/review-submitted.md)
31+
- [Review Requested](./triagebot/review-requested.md)
3132
- [Rustc Commit Tracking](./triagebot/rustc-commit-list.md)
3233
- [Shortcuts](./triagebot/shortcuts.md)
3334
- [Triagebot Dashboard](./triagebot/triage-dashboard.md)

src/triagebot/review-requested.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Review Requested
2+
3+
This feature will automatically adjust the labels on a pull request when the PR author requests a review from an assignee.
4+
5+
## Usage
6+
7+
In the list of reviewers, click the "Re-request review" button near an assignee's name.
8+
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.
9+
10+
## Configuration
11+
12+
This feature is enabled on a repository by having a `[review-requested]` table in `triagebot.toml`:
13+
14+
```toml
15+
[review-requested]
16+
# Those labels are removed when PR author requests a review from an assignee
17+
remove_labels = ["S-waiting-on-author"]
18+
# Those labels are added when PR author requests a review from an assignee
19+
add_labels = ["S-waiting-on-review"]
20+
```
21+
22+
## Implementation
23+
24+
See [`src/handlers/review_requested.rs`](https://github.com/rust-lang/triagebot/blob/HEAD/src/handlers/review_requested.rs).

0 commit comments

Comments
 (0)