Wednesday, August 25, 2021

Conventional Comments

This is an excellent piece on formatting comments in PR reviews.

Basically try and use this format where possible:

<label> [decorations]: <subject>

[discussion]

If you need help remembering what to use for each section or refer to the contents towards the end of the article. It provides a list of possible options for each (like what to use as decorations).