Giving more context about the code in the Pull Requests can improve the quality of the review and makes the reviewers’ life easier. One way to accomplish this is by using templates. A Pull request template is just a markdown file.
To create one Pull Request template in Github is very easy. All we have to do is to add a file named PULL_REQUEST_TEMPLATE in one of three locations:
- .github folder
- In the root of our project
- In the docs folder
Example:
https://github.com/Fragki/RomanNumerals/pull/1
Resources:
https://help.github.com/en/articles/about-issue-and-pull-request-templates