Use of conventional comments in code reviews
What does this MR do?
- Update the Reviewing a merge request section of the Code Review Guidelines:
- Recommend the use of prefixes (e.g.: https://conventionalcomments.org/#labels) to clarify code reviews.
- Re-order existing "not blocking" prefix usage to fit under the same recommendation.
Why?
- Help with code review efficiency by being very clear about what the author is being asked to do.
- Reduce personal feelings in reviews (e.g.: HackerNews comment; full thread).
- It opens the opportunity to do first-class categories, which enables better analytics of MRs.
- Remind us to think whether we're striking the right balance.
Why not?
- It's another thing reviewers/maintainers need to remember to do.
- 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
-
Changelog entry -
Documentation (if required) -
Code review guidelines -
Merge request performance guidelines -
Style guides -
Database guides -
Separation of EE specific content
Availability and Testing
N/A
Security
N/A
Edited by 🤖 GitLab Bot 🤖