Skip to content

Commit b356767

Browse files
authored
Merge pull request #867 from Urgau/triagebot-concern
Add documentation for triagebot `concern` command
2 parents 7310026 + d07454e commit b356767

File tree

2 files changed

+39
-0
lines changed

2 files changed

+39
-0
lines changed

src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
- [Behind Upstream](./triagebot/behind-upstream.md)
2121
- [Canonicalize Issue Links](./triagebot/canonicalize-issue-links.md)
2222
- [Close](./triagebot/close.md)
23+
- [Concern](./triagebot/concern.md)
2324
- [Documentation Updates](./triagebot/doc-updates.md)
2425
- [GitHub Releases](./triagebot/github-releases.md)
2526
- [Issue Links](./triagebot/issue-links.md)

src/triagebot/concern.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Concern
2+
3+
The `concern` command is used to formally register a concern at the top comment of a GitHub issue/PR.
4+
5+
## Usage
6+
7+
A concern can be registered by writing a comment with the command:
8+
9+
```text
10+
@rustbot concern my concern title
11+
```
12+
13+
The concern is then added in the top comment of the GitHub issue to a special section: `Concerns` (which should *not* be edited by hand).
14+
15+
*Concerns can only be registered by member of the organization and cannot be registered on active [rfcbot FCPs](https://rfcbot.rs).*
16+
17+
### Resolving a concern
18+
19+
Concerns can be resolved by writing a comment with the command:
20+
21+
```text
22+
@rustbot resolve my concern title
23+
```
24+
25+
The concern is then strikethrough and a link to the comment resolving the concern is added next to it.
26+
27+
## Configuration
28+
29+
This feature is enabled by having a `[concern]` table in `triagebot.toml`:
30+
31+
```toml
32+
[concern]
33+
labels = ["has-concerns"] # optional, list of labels to be added to the issue/PR when there are un-resolved concerns
34+
```
35+
36+
## Implementation
37+
38+
See [`parser/src/command/concern.rs`](https://github.com/rust-lang/triagebot/blob/HEAD/parser/src/command/concern.rs) and [`src/handlers/concern.rs`](https://github.com/rust-lang/triagebot/blob/HEAD/src/handlers/concern.rs).

0 commit comments

Comments
 (0)