-
Notifications
You must be signed in to change notification settings - Fork 215
Add documentation for triagebot concern command
#867
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,38 @@ | ||
| # Concern | ||
|
|
||
| The `concern` command is used to formally register a concern at the top comment of a GitHub issue/PR. | ||
|
|
||
| ## Usage | ||
|
|
||
| A concern can be registered by writing a comment with the command: | ||
|
|
||
| ```text | ||
| @rustbot concern my concern title | ||
| ``` | ||
|
|
||
| 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). | ||
|
|
||
| *Concerns can only be registered by member of the organization and cannot be registered on active [rfcbot FCPs](https://rfcbot.rs).* | ||
|
|
||
| ### Resolving a concern | ||
|
|
||
| Concerns can be resolved by writing a comment with command: | ||
|
|
||
| ```text | ||
| @rustbot resolve my concern title | ||
| ``` | ||
|
|
||
| The concern is then strikethrough and a link to the comment resolving the concern is added next to it. | ||
|
|
||
| ## Configuration | ||
|
|
||
| This feature is enabled by having a `[concern]` table in `triagebot.toml`: | ||
|
|
||
| ```toml | ||
| [concern] | ||
| labels = ["has-concerns"] # optional, list of labels automaticaly when there are un-resolved concerns | ||
Urgau marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ``` | ||
|
|
||
| ## Implementation | ||
|
|
||
| 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). | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.