diff options
author | Rémy Coutable <remy@rymai.me> | 2016-10-07 16:28:15 +0300 |
---|---|---|
committer | Rémy Coutable <remy@rymai.me> | 2016-10-07 16:28:15 +0300 |
commit | 2f7e28d1f700e1cdafb7771d4a61d8f71b68df04 (patch) | |
tree | b7f4cae1f573126bffb0f41f383d6844cd762c94 /doc/development/code_review.md | |
parent | 8581df3bfb9e847d07a585a22cfa21658ae40ea2 (diff) |
Improve the contribution and MR review guide
Signed-off-by: Rémy Coutable <remy@rymai.me>
Diffstat (limited to 'doc/development/code_review.md')
-rw-r--r-- | doc/development/code_review.md | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/development/code_review.md b/doc/development/code_review.md index 40ae55ab905..98279948888 100644 --- a/doc/development/code_review.md +++ b/doc/development/code_review.md @@ -34,6 +34,10 @@ request is up to one of our merge request "endbosses", denoted on the ## Having your code reviewed +Please keep in mind that code review is a process that can take multiple +iterations, and reviewer may spot things later that they may not have seen the +first time. + - The first reviewer of your code is _you_. Before you perform that first push of your shiny new branch, read through the entire diff. Does it make sense? Did you include something unrelated to the overall purpose of the changes? Did @@ -55,6 +59,7 @@ request is up to one of our merge request "endbosses", denoted on the Understand why the change is necessary (fixes a bug, improves the user experience, refactors the existing code). Then: +- Try to be thorough in your reviews to reduce the number of iterations. - Communicate which ideas you feel strongly about and those you don't. - Identify ways to simplify the code while still solving the problem. - Offer alternative implementations, but assume the author already considered @@ -66,6 +71,8 @@ experience, refactors the existing code). Then: "LGTM :thumbsup:", or "Just a couple things to address." - Avoid accepting a merge request before the build succeeds ("Merge when build succeeds" is fine). +- If you set the MR to "Merge when build succeeds", you should take over + subsequent revisions for anything that would be spotted after that. ## Credits |