Skip to content

Writing a Good Pull Request

Beka Westberg edited this page Apr 29, 2020 · 15 revisions

⚠️ 🚧 This page is under construction! 🚧 ⚠️


Pull requests are like life blood of a repository, they keep everything healthy and moving. Consequently, if the flow of PRs gets stopped up that can be bad. This page details how to create a PR that is complete and easy to review, which makes it more likely that your PR will get merged!

What follows are a few steps you can take to make sure you create the best PR possible.

  1. Communicate
  2. Get Set Up
  3. Keep it Small
  4. Keep it Clean
  5. Test your Change
  6. Communicate (pt2)

Communicate

Get Set Up

Keep it Small

Keep it Clean

Test your Change

Communicate

Clone this wiki locally