The suggested convention is to start a comment with one of the tags in bold. In markdown that would look like this: **Concern:**
If you think there is a more useful format, go for it and let me know how it turns out.
Tag | Implication | Expectation |
---|---|---|
[Default] i.e. no tag specified | Free form, interpret it as you will. | Context dependent. |
Bug | Reviewer is concerned that the code in question could cause problems in production. | Reviewer’s expectation is that the bug will be acknowledged, corrected or explained in some form. |
Question | Reviewer has general questions that may warrant addressing before a merge. | Reviewer’s expectation is that the question will be acked or answered in some form. |
Concern | This is something to consider an important issue and a response would be appreciated. | Reviewer’s expectation is that there will be a response most of the time. |
Suggestion | Reviewer thinks code could be improved, but change is not necessary. | Reviewer expects subm |