Skip to content

Instantly share code, notes, and snippets.

@indiesquidge

indiesquidge/pull_request_template.md

Last active August 30, 2024 19:57
Show Gist options
  • Save indiesquidge/85075be518631964a56b75946153ebbf to your computer and use it in GitHub Desktop.
Save indiesquidge/85075be518631964a56b75946153ebbf to your computer and use it in GitHub Desktop.
Download ZIP
An example PR template
Raw
pull_request_template.md
Status Type Env Vars Change Review App Ticket
Ready/Hold Feature/Bug/Tooling/Refactor/Hotfix Yes/No Link Link

⚠️ NOTE: use notes like this to emphasize something about the PR. This could include other PRs this PR is built on top of; new or removed environment variables; reasons for why the PR is on hold; or anything else you would like to draw attention to.

Problem

What problem are you trying to solve?

Solution

How did you solve the problem?

Before & After Screenshots

BEFORE: [insert screenshot here]

AFTER: [insert screenshot here]

Other changes (e.g. bug fixes, UI tweaks, small refactors)

Deploy Notes

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

New environment variables:

  • env var : env var details

New scripts:

  • script : script details

New dependencies:

  • dependency : dependency details

New dev dependencies:

  • dependency : dependency details
@Martinnord
Copy link

Thanks for this! Very helpful

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