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

Made with Slides.com