Skip to main content

Generic Pull Request Template

Add a file called pull_request_template.md to the root directory of your repository. Take a look at number of ways you can do this in GitHub. https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository

Title​

‍‍‍Provide a general summary of your changes in the title.

Description​

Describe your changes in detail. Link to the related issue ticket.

Context​

Why is this change required? What problem does it solve?

Link to related pull requests

How has this been tested?​

Please describe in detail how you tested your changes. Include details of your testing environment, and the tests you ran.

Screenshots​

Add screenshots or video if applicable.

Type of Change​

What types of changes does your code introduce? Put an x in all the boxes that apply:

  • 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)
  • Documentation
  • Tests

Sanity Checklist​

Go over all the following points, and put an x in all the boxes that apply. If you're unsure about any of these, don't hesitate to ask. Your team members are there to help!

  • My code follows the code style of this project.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • One or more required reviews requested.
  • Any dependent changes have been merged and published in upstream modules.
  • I have updated and verified the changes end-to-end and related documentation have been updated.