skip to Main Content

Standardizing your PRs with Github Pull Request Templates

  • By , Director of Engineering, Culture Foundry

We do all of our development using git, and most of our projects are hosting on Github. The pull request (PR) is a key part of our dev process, and writing excellent PR descriptions helps code reviewers and folks doing QA. This is something worth standardizing.

Here’s our typical PR template:

## TRELLO CARD

## DESCRIPTION

## TESTING

## DEPLOYMENT

The Trello card is a link to the card that defines the work this PR is completing. The description is enough context to give someone an understanding of the problem, likely with some technical details, but not just repeating what is in the card. Testing gives any special testing instructions, and deployment is, well, how do you deploy this change. (Many of our deployments are fully or partially automated, but some CMS changes need to be done manually.)

It’s easy to create a standard PR template in your Github repos following these instructions.

Back To Top