Skip to content

Instantly share code, notes, and snippets.

@bernii

bernii/pr_template.md

Last active October 30, 2015 17:24
Show Gist options
  • Save bernii/6c362f4e8d68e7d816f0 to your computer and use it in GitHub Desktop.
Save bernii/6c362f4e8d68e7d816f0 to your computer and use it in GitHub Desktop.
Download ZIP
PR template
Raw
pr_template.md

Ticket: WEB-XYZ @reviewer_handle please review [optional extra comments for reviewer]

Problem

Description of the problem that this code change is solving

Solution

GIF OR IMAGE IF POSSIBLE HERE

Description of the solution that this code changes are introducing to the application.

Comments

Extra comments. For example - what paths have you investigate, what were your findings, what did not finally land in this pull request etc. Any extra information that will give a better picture to the reviewer should land here too.

Possible improvements

As we do not live in an ideal world it's worth to share your thought on how we could make the solution even better.

Checklist

  • Is there any cruft that should be removed along with this code change? [comment if yes]
  • Is that code change resulting in any SQL query changes to the database? [comment if yes]
  • Is that code change resulting in any REST API route modifications? [comment if yes]
  • Have you inspected queries that are run on the DB by the changed code? [comment if yes]
  • Is that code change resulting in any performance changes to the application)? [comment if yes]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment