diff options
| author | Michael Kozono <mkozono@gmail.com> | 2018-11-26 21:04:00 +0300 |
|---|---|---|
| committer | Michael Kozono <mkozono@gmail.com> | 2018-11-28 21:37:17 +0300 |
| commit | 59b4db7f2c9ef94f4bb0e26a12febac97e0611c8 (patch) | |
| tree | 08da64beb621af2c04270a141c48a805a9c0d4b9 /doc | |
| parent | c88cea8191d67d7eee5d2cc20f1a5a6818834667 (diff) | |
Encourage MR author preparation
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/development/code_review.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/development/code_review.md b/doc/development/code_review.md index 52710e54e86..e0b72898ed2 100644 --- a/doc/development/code_review.md +++ b/doc/development/code_review.md @@ -72,6 +72,23 @@ If an author is unsure if a merge request needs a domain expert's opinion, that' usually a pretty good sign that it does, since without it the required level of confidence in their solution will not have been reached. +Before the review, the author is requested to submit comments on the merge +request diff alerting the reviewer to anything important as well as for anything +that demands further explanation or attention. Examples of content that may +warrant a comment could be: + +- The addition of a linting rule (Rubocop, JS etc) +- The addition of a library (Ruby gem, JS lib etc) +- Where not obvious, a link to the parent class or method +- Any benchmarking performed to complement the change +- Potentially insecure code + +Do not add these comments directly to the source code, unless the +reviewer requires you to do so. + +This +[saves reviewers time and helps authors catch mistakes earlier](https://www.ibm.com/developerworks/rational/library/11-proven-practices-for-peer-review/index.html#__RefHeading__97_174136755). + ### The responsibility of the maintainer Maintainers are responsible for the overall health, quality, and consistency of |