arosien/PULL_REQUEST_TEMPLATE.md

## PULL_REQUEST_TEMPLATE.md

      
    Raw
  

              PULL_REQUEST_TEMPLATE.md
            
          
Tag
Implication
Expectation


(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 submitter to consider if change is desirable/worthwhile and respond appropriately.


Nit
This is a weakly held opinion, I'm putting it out there, but if you ignore it, no big deal.
Reviewer has no expectation.


Todo
[This is more of a response]	File a tech debt or other Bug/Issue/JIRA and preferably put a comment in the code referencing it.


Approved and/or Emoji
Non-line comment expressing that the reviewer is done. Some review systems support this more directly, in which case you can skip it.
Tag	Implication	Expectation
(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 submitter to consider if change is desirable/worthwhile and respond appropriately.
Nit	This is a weakly held opinion, I'm putting it out there, but if you ignore it, no big deal.	Reviewer has no expectation.
Todo	[This is more of a response] File a tech debt or other Bug/Issue/JIRA and preferably put a comment in the code referencing it.
Approved and/or Emoji	Non-line comment expressing that the reviewer is done. Some review systems support this more directly, in which case you can skip it.