Adhering to a consistent format improves reader's expectations and machine readability. Here's the format we propose:
<label> [decorations]: <subject>
[discussion]
Where:
- label - This is a single label that signifies what kind of comment is being left.
- subject - This is the main message of the comment.
- decorations (optional) - These are extra decorating labels for the comment. They are surrounded by parentheses and comma-separated.
- discussion (optional) - This contains supporting statements, context, reasoning, and anything else to help communicate the “why” and “next steps” for resolving the comment.
These comments can be parsed into JSON easily for further processing.
https://conventionalcomments.org/
