From b53a9a4a0f5d5fb615c941d56de7befa4961e3da Mon Sep 17 00:00:00 2001 From: Jirka Borovec Date: Tue, 12 May 2020 22:17:47 +0200 Subject: [PATCH] Updated Review guidelines (markdown) --- Review-guidelines.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/Review-guidelines.md b/Review-guidelines.md index d1bd1fc..7c034a8 100644 --- a/Review-guidelines.md +++ b/Review-guidelines.md @@ -4,7 +4,12 @@ Some recommended steps for reviewing open PRs. 2. Read the changes if they are aligned with our code-base 3. Check if the changes (fixed issue, new feature) are **covered by tests** 4. Check if the change is mentioned in **CHANGELOG** (no need for typos, docs and CI) -5. If you checked all the above points, you may approve the PR in your review or request changes. Only approve it if you are confident that the issue or feature is fully addressed, otherwise leave a comment with your concerns. Note that if you approve and the PR reaches the minimum number of required approvals, and given that all tests pass, the branch will be automatically merged into master. +5. If you checked all the above points, you may approve the PR in your review or request changes. Only approve it if you are confident that the issue or feature is fully addressed, otherwise leave a comment with your concerns. The actual `mergify` automation is set for N approvals so each approval matter and you shall be confident with your action... the rule of the tongue says: + - Approve: if you completely agree with the content to be merged as it is now (no extra condition in comments) + - Comment: not sure in any direction (your understanding, affect in global, etc.) but you want to express your opinion about a specific point + - Request changes: if you are sure that the actual change will break something or has obvious issues + +Remember that if you approve a PR and it reaches the minimum number of required approvals and given that all tests pass, the branch will be automatically merged into master. ## Hints and remarks