From b829be133abb36a34f5e1833fac44ee66ce15573 Mon Sep 17 00:00:00 2001 From: Elle Mouton Date: Wed, 15 Dec 2021 10:36:36 +0200 Subject: [PATCH] docs: add review bot commands to guidelines [skip ci] Add the review bot commands to the contribution guidelines so that we can link to these commands from the bots readme. --- docs/code_contribution_guidelines.md | 36 ++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/docs/code_contribution_guidelines.md b/docs/code_contribution_guidelines.md index a2032a705..2d44754ef 100644 --- a/docs/code_contribution_guidelines.md +++ b/docs/code_contribution_guidelines.md @@ -17,6 +17,7 @@ 1. [Code Review](#code-review) 1. [Rework Code (if needed)](#rework-code-if-needed) 1. [Acceptance](#acceptance) + 1. [Review Bot](#review-bot) 6. [Contribution Standards](#contribution-standards) 1. [Contribution Checklist](#contribution-checklist) 1. [Licensing of Contributions](#licensing-of-contributions) @@ -571,6 +572,41 @@ these signatures intact, we prefer using merge commits. PR proposers can use Rejoice as you will now be listed as a [contributor](https://github.com/lightningnetwork/lnd/graphs/contributors)! +## Review Bot + +In order to keep the review flow going, Lightning Labs uses a bot to remind +PR reviewers about their outstanding reviews or to remind authors to address +recent reviews. Here are some important things to know about the bot and some +controls for adjusting its behaviour: + +####🤖 Expected Behaviour: +- The bot will not do anything if your PR is in draft mode. +- It will ping a pending reviewer if they have not reviewed or commented on the +PR in x days since the last update or the last time the bot pinged them. +(default x = 3) +- It will ping the author of the PR if they have not addressed a review on a PR +after x days since last review or the last time the bot pinged them. It will +also ping them to remind them to re-request review if needed. (default x = 3) + +####🤖 Controls: +To control the bot, you need to add a comment on the PR starting with +`!lightninglabs-deploy` followed by the command. There are 2 control types: +mute/unmute & cadence. Only the latest comment for each control type will be +used. This also means you dont need to keep adding new control comments, just +edit the latest comment for that control type. + +- `!lightninglabs-deploy mute` will mute the bot on the PR completely. +- `!lightninglabs-deploy mute 72h30m` will mute the bot for the given duration. +- `!lightninglabs-deploy mute 2022-Feb-02` will mute the bot until the given +date (must be in this format!). +- `!lightninglabs-deploy mute #4` will mute the bot until the given PR of the +same repo has been merged. +- `!lightninglabs-deploy unmute` will unmute the bot (or just delete the comment +that was muting it) +- `!lightninglabs-deploy cadence 60h` change the cadence of the bot from the +default of 3 days to the given duration. +- it will auto-mute if the PR is in Draft mode + # Contribution Standards ## Contribution Checklist