Skip to content

Use of conventional comments in code reviews

Thiago Figueiró requested to merge mr-review-conventional-comments into master

What does this MR do?

  1. Update the Reviewing a merge request section of the Code Review Guidelines:
    1. Recommend the use of prefixes (e.g.: https://conventionalcomments.org/#labels) to clarify code reviews.
    2. Re-order existing "not blocking" prefix usage to fit under the same recommendation.

Why?

  1. Help with code review efficiency by being very clear about what the author is being asked to do.
  2. Reduce personal feelings in reviews (e.g.: HackerNews comment; full thread).
  3. It opens the opportunity to do first-class categories, which enables better analytics of MRs.
  4. Remind us to think whether we're striking the right balance.

Why not?

  1. It's another thing reviewers/maintainers need to remember to do.
  2. what else?

Disclaimer: my interest in this originated in a Defend retrospective. Someone suggested using prefixes and, at some point, @pslaughter chimed-in with the awesome work he had already done in this space. I offered to create this MR and kick-off the discussion around adopting the use of prefixes in our reviews.

Screenshots

N/A

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

N/A

Security

N/A

Edited by 🤖 GitLab Bot 🤖

Merge request reports