How to customize your Github PR description

Rajdeep Chandra
1 min readJun 21, 2022

--

Well!! are you tired of telling your juniors or co-workers to put in the description of your ticket. I also faced the same in some point of your career to maintain a good PR hygiene but it definitely falls out when you are working in remote teams or in split teams. So I have create a small snippet to automate your PR description so that your team can follow a generic pattern for your project.

Step 1: Create a .github folder on your root in your VS code

Step 2: Create a file name .github/PULL_REQUEST_TEMPLATE.md

Step 3: Put in the contents as below: (Note: This is an example)

## Summary
_1–2 line summary of changes_

## Jira ticket(s)
_Please mention the Jira story/bug corresponding to the change_

## Checklist
- [ ] This PR represents a single feature, fix, or change

- [ ] These changes have been tested locally

- [ ] Unit tests have been added for this change

- [ ] Storybook was updated for this change

- [ ] Updated relevant documentation (Storybook docs)

--

--