GitHub Pull Request Template a faster way to document a PR

Sameer
Dec 23, 2021

--

Why do you need a Pull Request Template?

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.

How to add a GitHub PR Template?

Create a file pull_request_template.md inside a root folder of the repository called ./github

./github/pull_request_template.md

This file is nothing but a template that will be shown on GitHub PR, when the PR is raised.

Sample Template file

Download a sample md file from below link.

Sign up to discover human stories that deepen your understanding of the world.

Free

Distraction-free reading. No ads.

Organize your knowledge with lists and highlights.

Tell your story. Find your audience.

Membership

Read member-only stories

Support writers you read most

Earn money for your writing

Listen to audio narrations

Read offline with the Medium app

--

--

Sameer
Sameer

Written by Sameer

I am working as a Senior Software Engineer. I have 10+ years of Java Stack experience.

No responses yet

Write a response