Skip to content

Commit

Permalink
add more details about shortcuts
Browse files Browse the repository at this point in the history
  • Loading branch information
chenyukang committed Jan 14, 2024
1 parent 4722829 commit 527e0ad
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
5 changes: 4 additions & 1 deletion src/rustbot.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,12 @@ the `@rustbot` command will look like this:
@rustbot label -S-waiting-on-author +S-waiting-on-review

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

[labeling]: https://forge.rust-lang.org/triagebot/labeling.html
[shortcuts]: https://forge.rust-lang.org/triagebot/shortcuts.html

## Other commands

Expand Down
5 changes: 3 additions & 2 deletions src/walkthrough.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ request that reviewer by leaving a comment on the thread with `r?
don't request anyone; the bot will assign someone automatically based on which files you changed.

The reviewer may request changes before they approve your PR, they may mark the PR with label
"S-waiting-on-author" after leaving comments, this means that the PR is blocked on you to making
"S-waiting-on-author" after leaving comments, this means that the PR is blocked on you to make
some requested changes. When you finished iterating on the changes, you can mark the PR as
`S-waiting-on-review` again by leaving a comment with `@rustbot ready`, this will remove the
`S-waiting-on-author` label and add the `S-waiting-on-review` label.
Expand All @@ -196,7 +196,8 @@ Feel free to ask questions or discuss things you don't understand or disagree wi
recognize that the PR won't be merged unless someone on the Rust team approves
it. If a reviewer leave a comment like `r=me after fixing ...`, that means they approve the PR and
you can merge it with comment with `@bors r=reviwer-github-id`(e.g. `@bors r=eddyb`) to merge it
after fixing lefted trivial issues.
after fixing lefted trivial issues. `r=someone` requires permission and the reviwer use
delegate command gives it to you in this way.

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

0 comments on commit 527e0ad

Please sign in to comment.