Skip to content

Instantly share code, notes, and snippets.

@zachwinnie

zachwinnie/PULL_REQUEST_TEMPLATE.md

Created January 5, 2021 18:09
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save zachwinnie/fb84ba3f2cd2807d77769d1b26d74d66 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save zachwinnie/fb84ba3f2cd2807d77769d1b26d74d66 to your computer and use it in GitHub Desktop.
Download ZIP
PR Template
Raw
PULL_REQUEST_TEMPLATE.md

Purpose

  • Describe the reason for the changes in this pull request

Feedback

  • Describe what you'd like the reviewer to look at and potentially comment on

Testing

  • Describe for the reviewer the steps needed to test this pull request

Checklist

  • Context: I have described the purpose of the changes within this pull request through PR comments, code comments, and in the purpose above
  • Tests: I have added unit, integration, and functional tests (as appropriate)
  • Code Quality: I have linted, built, and tested the code locally
  • Browsers: I have tested functionality locally in supported browsers (Chrome, Firefox, Safari, IE11)
  • Documentation: I have added documentation to the appropriate wiki, API docs, or knowledge base

Reminders

  • Set WIP: as the first word of the PR title while working on your code
  • Set [Ready] in the PR title when the PR is open for review
  • Once approved and merged, verify that your changes went through to production successfully
  • Once approved and merged, verify your changes on mobile browsers (iOS Safari and Android Chrome)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment