🚀 Boost your teams' code review practice!

A great way to help your team's async code review pratice is to outline a set of standard questions and information for each pull request.

And thankfully, this is easy to do with GitHub!

Below is a pull request template that you can add to your repository to prompt a author to add specific details whenever they open a new PR.

Simply follow the steps:

  • Copy the contents of the markdown file below
  • Paste the contents into a file called PULL_REQUEST_TEMPLATE.md
  • Navigate to your repository
  • Move the file into the .github directory (if you don't have one, create it)

🎉 Now every new pull request will prompt the author to fill in the sections of the template!

This template comes right out of the pages in my book: Code Review Champion. If you want to learn more about how to build a great code review practice on your team, check it out!

<!--
  Thanks for wanting to contribute to this project!

  To help things move along, provide a description of your changes below and a general summary in the title

  Please look at the following checklist to ensure that your PR can be accepted quickly:
-->

## Description and Context
<!-- Describe your changes in detail and provide helpful context.
<!-- Why is this change required? What problem does it solve? -->
<!-- If it fixes an open issue, please link to the issue here. Other related links are encouraged! -->

## 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)
- [ ] Refactor / internal changes (changes do not affect functionality, but are an improvement to the codebase)

## Screenshots
<!-- If your changes affect how information is displayed or gathered (especially in a UI, report, or CLI), include a screen shot here --->
<!-- Annotated before and after screenshots are encouraged! --->

## Checklist
<!-- Go over all the following points, and put an \`x\` in all the boxes that apply. -->
- [ ] I added tests to cover my changes
- [ ] All new and existing tests are passing
- [ ] I formatted and linted the code according to repo specs
- [ ] I rebased changes with main so that they can be merged easily
- [ ] I have updated the documentation accordingly (if applicable)

<!--
    Thanks for adding all that information! 

    Once you open the PR, go through the code yourself and add any comments in places where additional context or clarity might be helpful to reviewers. 
    If you had a hard time choosing between a few different implementation solutions, provide a little context as to why and what other solutions you considered.

    Thanks for helping us keep a smooth and low-friction code review practice!
-->