From 472282938a0b200b0648cebcc77b671892062027 Mon Sep 17 00:00:00 2001 From: yukang Date: Fri, 12 Jan 2024 13:04:22 +0800 Subject: [PATCH 1/3] add some explain for rustbot commands --- src/contributing.md | 2 +- src/walkthrough.md | 13 ++++++++++--- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/src/contributing.md b/src/contributing.md index d6b9fc84d..6e9e3db6b 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -249,7 +249,7 @@ If you encounter merge conflicts or when a reviewer asks you to perform some changes, your PR will get marked as `S-waiting-on-author`. When you resolve them, you should use `@rustbot` to mark it as `S-waiting-on-review`: - @rustbot label -S-waiting-on-author +S-waiting-on-review + @rustbot ready See [this chapter][labeling] for more details. diff --git a/src/walkthrough.md b/src/walkthrough.md index b8311b19a..fd3633e56 100644 --- a/src/walkthrough.md +++ b/src/walkthrough.md @@ -186,10 +186,17 @@ request that reviewer by leaving a comment on the thread with `r? @reviewer-github-id` (e.g. `r? @eddyb`). If you don't know who to request, 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. Feel free to ask -questions or discuss things you don't understand or disagree with. However, +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 +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. + +Feel free to ask questions or discuss things you don't understand or disagree with. However, recognize that the PR won't be merged unless someone on the Rust team approves -it. +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. 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 From 527e0ad3532a219f0614115045424b07743bc636 Mon Sep 17 00:00:00 2001 From: yukang Date: Sun, 14 Jan 2024 19:03:06 +0800 Subject: [PATCH 2/3] add more details about shortcuts --- src/rustbot.md | 5 ++++- src/walkthrough.md | 5 +++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/src/rustbot.md b/src/rustbot.md index 0959224f0..88b831697 100644 --- a/src/rustbot.md +++ b/src/rustbot.md @@ -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 diff --git a/src/walkthrough.md b/src/walkthrough.md index fd3633e56..4d867c608 100644 --- a/src/walkthrough.md +++ b/src/walkthrough.md @@ -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. @@ -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 From 3b4bdfcd68dd2f75972ab038f41d2360feddb50e Mon Sep 17 00:00:00 2001 From: Yukang Date: Sat, 20 Jan 2024 19:47:56 +0800 Subject: [PATCH 3/3] fix words on `r=someone` Co-authored-by: Yuki Okushi --- src/walkthrough.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/walkthrough.md b/src/walkthrough.md index 4d867c608..704c1be0d 100644 --- a/src/walkthrough.md +++ b/src/walkthrough.md @@ -196,8 +196,9 @@ 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. `r=someone` requires permission and the reviwer use -delegate command gives it to you in this way. +after fixing trivial issues. Note that `r=someone` requires permission and bors could say +something like "🔑 Insufficient privileges..." when commenting `r=someone`. In that case, +you have to ask the reviewer to revisit your PR. 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