Conventional comments
Wojciech Trawiński
xStation Guild, 23.06.2022
Goal
Provide additional context
to our comments in code reviews
by prefixing them with one of the labels,
so that the intent of an author is clear
and comment are well thought.
inspired by
Format and labels
<label> [decorations]: <subject>
[discussion]- praise,
- nitpick,
- question,
- thought,
- todo,
- chore,
- issue,
- suggestion.
Benefits
- increased engagement in code reviews,
- more focused and adequate comments,
- clear intentions of comments' author,
- increased team morale by giving praises,
- sharing knowledge in code reviews (thoughts).
Action points
- agree on the list of labels,
- agree on the local names of labels if needed,
- investigate usage of the browser extension for GitLab code reviews.