Commit 510a32e0 authored by Wayne Haber's avatar Wayne Haber

Merge branch 'mr-review-conventional-comments' into 'master'

Use of conventional comments in code reviews

See merge request gitlab-org/gitlab!32020
parents 706422f9 c32bac13
...@@ -308,10 +308,11 @@ experience, refactors the existing code). Then: ...@@ -308,10 +308,11 @@ experience, refactors the existing code). Then:
- Seek to understand the author's perspective. - Seek to understand the author's perspective.
- If you don't understand a piece of code, _say so_. There's a good chance - If you don't understand a piece of code, _say so_. There's a good chance
someone else would be confused by it as well. someone else would be confused by it as well.
- Do prefix your comment with "Not blocking:" if you have a small, - Ensure the author is clear on what is required from them to address/resolve the suggestion.
non-mandatory improvement you wish to suggest. This lets the author - Consider using the [Conventional Comment format](https://conventionalcomments.org#format) to
know that they can optionally resolve this issue in this merge request convey your intent.
or follow-up at a later stage. - For non-mandatory suggestions, decorate with (non-blocking) so the author knows they can
optionally resolve within the merge request or follow-up at a later stage.
- After a round of line notes, it can be helpful to post a summary note such as - After a round of line notes, it can be helpful to post a summary note such as
"LGTM :thumbsup:", or "Just a couple things to address." "LGTM :thumbsup:", or "Just a couple things to address."
- Assign the merge request to the author if changes are required following your - Assign the merge request to the author if changes are required following your
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment