Skip to content

Instantly share code, notes, and snippets.

@hcopperm

hcopperm/PR_template.md

Last active May 6, 2020 22:17
Show Gist options
  • Save hcopperm/865e497d251f9254d9fb04f0f306c1e9 to your computer and use it in GitHub Desktop.
Save hcopperm/865e497d251f9254d9fb04f0f306c1e9 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
PR_template.md

{Link to JIRA ticket}

Description

A few sentences describing the overall goals of the pull request's commits. Make sure to include enough context for a reviewer who might not have much background.

Testing description

Include a description of what you've done to test the PR. For example, did you deploy it to staging and test against real data?

Visual design

If this is a design-related ticket, include screenshots of your changes

Reminders for Requester

  • Adequate test coverage
  • Code has been tested in real environments (locally and on staging)
  • Documentation
  • Review your own code
  • Send to UX/PM if necessary

Reminders for Reviewer

  • Is this code understandable?
  • Has the requester included enough context?

Deploy Notes

Notes regarding deploying the PR. These should note any db migrations, etc.

Steps to Test or Reproduce

Outline the steps to test or reproduce the PR here. Add instructions for non-developers if necessary.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment