Authors: @Kelley Chau

Last Updated: 3/27/21

Overview

When to make a PR

It's helpful to make PRs when you start working on a feature and create and push a new branch! This helps increase visibility for the rest of your team into what you're working on and your current progress.

This is why we prefer draft PRs (links to below)- they let you make a PR and run CI for unfinished code that isn't ready to be reviewed.

PRs should be relatively small in scope for manageability- less code to review means faster approvals and less blockers for others on your team!

Choosing a branch

• Sometimes after pushing to a branch, Github will suggest you make a PR for that on the repo page. Click the button!
• Otherwise, click on the Pull Requests tab (to the right of Issues) and choose your branch to be the compare branch.

Here, we are making a PR for the deployment branch to merge into master.

Creating a new PR

• Fill out the template that pops up (see Contents below for some extra tips)
  • There might not be a template or you might see something slightly different; regardless, it's important to be descriptive about the current state of the PR
• Assign reviewers — this could be others who have worked on similar or the same feature(s), your leads, or designers. Anyone you want to go through to make sure your code and feature are good to go!
• Either make it a draft PR (see below👇) or if you feel your code is ready for review, click the green Create pull request button.

todo: managing code review comments??

Merging