Create a GitHub PR Template
February 08, 2020
PR templates are one of my favorite features. I can't remember when I first learned about them but essentially, it's a template which appears when someone opens a pull request on your project. This comes in handy for projects with multiple contributors.
If you prefer to learn by watching, you can find this on egghead.
Here's how you can set it up:
- Create a
.githubdirectory at the root of your project
- Add a file called
pull_request_template.md. Here's an example:
This PR...## Changes-## Screenshots(prefer animated gif)## Checklist- [ ] tested locally- [ ] added new dependencies- [ ] updated the docs- [ ] added a testFixes #
- Make sure these changes are on the default branch
- Open a PR and viola! See your template in action.
Enjoy the added benefits of using PR templates!