Skip to content

Instantly share code, notes, and snippets.

@adavis

adavis/PULL_REQUEST_TEMPLATE.md

Last active March 23, 2024 19:36
Show Gist options
  • Star 7 You must be signed in to star a gist
  • Fork 5 You must be signed in to fork a gist
  • Save adavis/9fe5ea92d9b19727cbe7b69e8c9e9f66 to your computer and use it in GitHub Desktop.
Save adavis/9fe5ea92d9b19727cbe7b69e8c9e9f66 to your computer and use it in GitHub Desktop.
Download ZIP
Sample Pull Request template for use on GitHub
Raw
PULL_REQUEST_TEMPLATE.md

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.

Fixed #issue

Type of Change

Please delete options that are not relevant.

  • 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 not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes.

  • Test A
  • Test B

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any changes to strings have been published to our translation tool
@adavis
Copy link
Author

adavis commented Jun 9, 2022

Thank you for the template!

You're welcome!

@lokinagure
Copy link

This is very simple and effective.
Simply Awseome. Thanks for the tamplate.

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