Conventional Comments

Based on the Conventional Comments standard. Comments that are easy to grok and grep.

Comment Format

<label> [decorations]: <subject>

[discussion]

• label (required) — a single word signifying the kind of comment
• subject (required) — the main message of the comment
• decorations (optional) — extra classifiers in parentheses, comma-separated, placed after the label
• discussion (optional) — supporting statements, context, reasoning, and next steps

Labels