Pull Request(PR) are often when raised are not properly documented. The best way to document them is to use a consistent template. The Template will help the team to document the PR in a concise way. PR reviewer gets an idea about what to expect in a PR.
Create a file
pull_request_template.md inside a root folder of the repository called
This file is nothing but a template that will be shown on GitHub PR, when the PR is raised.
## Description <!-- Please write a brief information about PR, what it contains, its purpose --> ## Link to Jira <!-- If there is a ticket for this --> ## Screenshots <!-- Please add screenshots --> ## Testing <!-- How to test PR -->
Click to Download a sample PR Template.