Skip to content

Commit b99b876

Browse files
Add some explanations for frequently used rustbot commands (rust-lang#1849)
* add some explain for rustbot commands * add more details about shortcuts * fix words on `r=someone` Co-authored-by: Yuki Okushi <[email protected]> --------- Co-authored-by: Yuki Okushi <[email protected]>
1 parent 9ad9d15 commit b99b876

File tree

3 files changed

+17
-5
lines changed

3 files changed

+17
-5
lines changed

Diff for: src/contributing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ If you encounter merge conflicts or when a reviewer asks you to perform some
255255
changes, your PR will get marked as `S-waiting-on-author`. When you resolve
256256
them, you should use `@rustbot` to mark it as `S-waiting-on-review`:
257257

258-
@rustbot label -S-waiting-on-author +S-waiting-on-review
258+
@rustbot ready
259259

260260
GitHub allows [closing issues using keywords][closing-keywords]. This feature
261261
should be used to keep the issue tracker tidy. However, it is generally preferred

Diff for: src/rustbot.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,12 @@ the `@rustbot` command will look like this:
4444
@rustbot label -S-waiting-on-author +S-waiting-on-review
4545

4646
The syntax for this command is pretty loose, so there are other variants of this
47-
command invocation. For more details, see [the docs page about labeling][labeling].
47+
command invocation. There are also some shortcuts to update labels,
48+
for instance `@rustbot ready` will do the same thing with above command.
49+
For more details, see [the docs page about labeling][labeling] and [shortcuts][shortcuts].
4850

4951
[labeling]: https://forge.rust-lang.org/triagebot/labeling.html
52+
[shortcuts]: https://forge.rust-lang.org/triagebot/shortcuts.html
5053

5154
## Other commands
5255

Diff for: src/walkthrough.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -186,10 +186,19 @@ request that reviewer by leaving a comment on the thread with `r?
186186
@reviewer-github-id` (e.g. `r? @eddyb`). If you don't know who to request,
187187
don't request anyone; the bot will assign someone automatically based on which files you changed.
188188

189-
The reviewer may request changes before they approve your PR. Feel free to ask
190-
questions or discuss things you don't understand or disagree with. However,
189+
The reviewer may request changes before they approve your PR, they may mark the PR with label
190+
"S-waiting-on-author" after leaving comments, this means that the PR is blocked on you to make
191+
some requested changes. When you finished iterating on the changes, you can mark the PR as
192+
`S-waiting-on-review` again by leaving a comment with `@rustbot ready`, this will remove the
193+
`S-waiting-on-author` label and add the `S-waiting-on-review` label.
194+
195+
Feel free to ask questions or discuss things you don't understand or disagree with. However,
191196
recognize that the PR won't be merged unless someone on the Rust team approves
192-
it.
197+
it. If a reviewer leave a comment like `r=me after fixing ...`, that means they approve the PR and
198+
you can merge it with comment with `@bors r=reviwer-github-id`(e.g. `@bors r=eddyb`) to merge it
199+
after fixing trivial issues. Note that `r=someone` requires permission and bors could say
200+
something like "🔑 Insufficient privileges..." when commenting `r=someone`. In that case,
201+
you have to ask the reviewer to revisit your PR.
193202

194203
When your reviewer approves the PR, it will go into a queue for yet another bot
195204
called `@bors`. `@bors` manages the CI build/merge queue. When your PR reaches

0 commit comments

Comments
 (0)