Skip to content

Instantly share code, notes, and snippets.

@spacerockzero
Last active December 17, 2015 05:18
Show Gist options
  • Save spacerockzero/5556669 to your computer and use it in GitHub Desktop.
Save spacerockzero/5556669 to your computer and use it in GitHub Desktop.
100% optional PR template (I leave out as much as possible, keep only what is absolutely needed for each PR). This PR template is written in Github-Flavored Markdown, so it has some nice formatting for headings, checkboxes, lists, etc when you paste it into a github PR. I've found this to be very helpful in clarifying and speeding up handoffs an…
# Problem space:
- We don't have a lot of trust in our pull request communication
- We don't always know what the creator has tested, or where the change is applicable
[insert photo of problem or design mockup, if applicable]
# Changes:
- [ ] ENG-1337 : create the ideal pull request format.
- [ ] Do as much as is absolutely needed, but no more
- [ ] Keep it flexible, and fast, so the reviewer can get up to speed as fast as possible
- [ ] Inspire trust and determine scope in your handoff
- [ ] Visualize the problem and what it solves
[insert photo of fix or finished product screencap, if applicable]
# Affects:
- /images
- /albums
# Should:
- [ ] do thing 1 when you perform task 1
- [ ] do thing 2 when you perform task 2
- [ ] do thing 3 when you perform task 3
# Tested in browsers:
- [ ] IE10
- [ ] IE9
- [ ] IE8
- [ ] IE7 :: **functional, but float alignment is a bit off**
- [ ] firefox OSX
- [ ] firefox win7
- [ ] chrome OSX
- [ ] chrome win7
- [ ] ios6.1 iPhone
- [ ] ios6.1 iPad
- [ ] android phone (mobile chrome)
- [ ] android phone (mobile chrome)
# Tested in languages:
- [ ] DE
- [ ] EN
- [ ] ES
- [ ] FR
- [ ] IT
- [ ] JA
- [ ] KO
- [ ] PT
- [ ] RU
- [ ] ZH
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment