Skip to content

Instantly share code, notes, and snippets.

@meyerhoferc

meyerhoferc/pull-request-template.md

Forked from Lordnibbler/pull-request-template.md
Last active March 16, 2018 22:35
Show Gist options
  • Save meyerhoferc/e336202015f23020863f48a9a718a134 to your computer and use it in GitHub Desktop.
Save meyerhoferc/e336202015f23020863f48a9a718a134 to your computer and use it in GitHub Desktop.
Download ZIP
Sample Pull Request Template
Raw
pull-request-template.md

Status: READY/WIP

JIRA tickets

DEV-XYZ

Migrations

YES | NO

If YES, list changes.

Summary

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

Code Interactions

A few sentences or bullet points describing any possible code interactions associated with this PR.

Questions

A place to ask questions of the reviewer / dev team about the functional requirements, design, or implementation.

Todos

  • Tests
  • Documentation

Deploy Notes

Notes regarding deployment to staging/production or local setup. These should note any db migrations, necessary rake tasks, etc.

Functional Verification

  • any relevant screenshots / videos / command line examples
  • summary of what to verify, including any steps that are non-intuitive
  • edges cases to check
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment