Skip to content

Instantly share code, notes, and snippets.

@littlelazer

littlelazer/pull_request_template.md

Forked from duretti/pull_request_template.md
Created May 13, 2016 06:24
Show Gist options
  • Save littlelazer/fe23aaa039ea67d5d0f46262e39e79e6 to your computer and use it in GitHub Desktop.
Save littlelazer/fe23aaa039ea67d5d0f46262e39e79e6 to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. @duretti duretti revised this gist May 10, 2016. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pull_request_template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -1,6 +1,6 @@
    ## Overview

    Here, you might lay out the reasons behind writing this code. You can link to specs, issues, or bugs in order to give someone a better idea of how a decision was made. This is your chance to give context to your reviewer. Ego depletion - the idea that willpower is used up over time - can be easily applied to your reviewer. We are all human, after all. You'll likely get one shot at a quality review, so help your reviewer help you. Flush out this section.
    Here, you might lay out the reasons behind writing this code. You can link to specs, issues, or bugs in order to give someone a better idea of how a decision was made. This is your chance to give context to your reviewer. Ego depletion - the idea that willpower is used up over time - can be easily applied to your reviewer. We are human, after all. You'll likely get one shot at a quality review, so help your reviewer help you. Flush out this section.

    ## Testing
    How did you test this code? Did you write a unit test, or test it manually? Can you provide an animated gif or a screenshot to demonstrate your code does what it purports to do? What about test output or a useful snippet from a logfile? Help show that your code works.
  2. @duretti duretti revised this gist May 9, 2016. 1 changed file with 6 additions and 2 deletions.
    8 changes: 6 additions & 2 deletions pull_request_template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -1,7 +1,11 @@
    ## Overview

    Here, you might lay out the reasons behind writing this code. You can link to specs, issues, or bugs in order to give someone a better idea of how a decision was made. This is your chance to give context to your reviewer. Ego depletion - the idea that willpower is used up over time - can be easily applied to your reviewer. We are all human, after all. You'll likely get one shot at a quality review, so help your reviewer help you. Flush out this section.

    ## Testing
    How did you test this code? Did you write a unit test, or test it manually? Can you provide an animated gif or a screenshot to demonstrate your code does what it purports to do? What about test output or a useful snippet from a logfile? Help show that your code works.

    ## Risks
    ## 🚨🚨🚨 (Risks)
    Is there some part of the code that you know probably doesn't work as it should? Call out potential weak spots, and get help addressing them.

    (a chance for whimsy)
    (this is the part where I upload an animated gif, for whimsy's sake - not everything has to be serious :grin:)
  3. @duretti duretti created this gist May 9, 2016.
    7 changes: 7 additions & 0 deletions pull_request_template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,7 @@
    ## Overview

    ## Testing

    ## Risks

    (a chance for whimsy)