Skip to content

Instantly share code, notes, and snippets.

@thejimbirch

thejimbirch/pull_request_template.md

Forked from kwhite/pull_request_template.md
Created October 10, 2018 16:12
Show Gist options
  • Save thejimbirch/bef6e8ee6c931594d4c2ed096806488c to your computer and use it in GitHub Desktop.
Save thejimbirch/bef6e8ee6c931594d4c2ed096806488c to your computer and use it in GitHub Desktop.
Download ZIP
An example PR template
Raw
pull_request_template.md

Description

As a developer, I need to start with a story.

A few sentences describing the overall goals of the pull request's commits. What is the current behavior of the app? What is the updated/expected behavior with this PR? Include your acceptance critiera! If your tasks were well-written, you can probably copy/paste some of this.

Affected URL

link_to_relevant_multidev_or_test_site

Related Tickets

Steps to Validate

  1. A list of steps to validate
  2. Include direct links to test sites -- specific nodes, admin screens, etc
  3. Be explicit

Deploy Notes

Notes regarding deployment of the contained body of work. These should note any new dependencies, new scripts, etc.

New scripts:

  • script : script details

New dependencies:

  • dependency : dependency details

New dev dependencies:

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