Skip to content

Instantly share code, notes, and snippets.

@holmesal

holmesal/pull-request-template.md

Forked from Lordnibbler/pull-request-template.md
Last active December 12, 2016 23:02
Show Gist options
  • Save holmesal/79551e67c5a0f5382c72e4e6ff02bf52 to your computer and use it in GitHub Desktop.
Save holmesal/79551e67c5a0f5382c72e4e6ff02bf52 to your computer and use it in GitHub Desktop.
Download ZIP
Sample Pull Request Template
Raw
pull-request-template.md

Migrations

YES | NO

Description

A few sentences describing the overall goals of the pull request's commits.

Related PRs

List related PRs against other branches:

branch PR
some_other_PR link

Todos

  • Tested and working locally
  • Tested and working on development environment
  • New API endpoints documented on Apiary
  • Unit tests (if appropriate)
  • Reviewed and approved by a senior dev
  • QA-d and approved by a QA person

How to deploy

Notes about how to deploy this work. For example, running a migration against the production DB.

How to QA

Outline the steps to test or reproduce the PR here.

Impacted Areas in Application

List general components of the application that this PR will affect:

If this code breaks in production, then...

What's the worst-case scenario?

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