Skip to content

Instantly share code, notes, and snippets.

@chranderson

chranderson/pull_request_template.md

Last active July 26, 2024 20:08
Show Gist options
  • Save chranderson/f15d866783c9936c805e0af1b894ff83 to your computer and use it in GitHub Desktop.
Save chranderson/f15d866783c9936c805e0af1b894ff83 to your computer and use it in GitHub Desktop.
Download ZIP
Pull Request Template with checklist
Raw
pull_request_template.md

Description and Context

Type of Change:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Refactor / internal changes (changes do not affect functionality, but are an improvement to the codebase)

Checklist:

  • Changes have been tested.
  • All new and existing tests are passing.
  • Any new errors or warnings that were caused by your changes have been fixed.
  • Documentation has been added or updated if necessary.

A visual tells a thousand words

@chranderson
Copy link
Author

Copy & paste the raw markup into a file named pull_request_template.md in the .github/ directory of your repo.
You can adjust repo settings in Github to only allow the merge when all checkboxes are checked.

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