Skip to content

Merging a Pull Request

Jason R. Clark edited this page Aug 4, 2017 · 2 revisions

Merging a Pull Request

If you've been given commit rights on the Shoes repo, congrats! 🚀 💃 ✨

We don't have a huge process around merging changes while we're still pre-release, but there are a few steps to take.

  1. As a member of the Shoes team, feel free to push branches on the main repo rather than your fork. In some cases this helps with collaboration since others can work against that branch too if needed.

  2. Get your code reviewed by at least one other team member. Generally this doesn't take too long, but feel free to ping folks if there doesn't seem to be any motion!

  3. Merge from master (or rebase) if Github tells you it can't merge. Occasionally if there's a lot of activity on the project, you might want to merge and test again as well just to be sure nothing's collided, even if the source merged cleanly.

  4. Click the big green button "Merge pull request"! But wait! In the commit message field for the merge commit, write up a brief snippet summarizing the changes (especially if the PR encompasses multiple different other comments), and include one of the following bits of text depending on the type of change:

    • Changelog: feature
    • Changelog: improvement
    • Changelog: bugfix

This helps us build out the CHANGELOG between releases in a more automated fashion. Here's an example merge commit message from a PR:

Merge pull request #767 from Suirtimed/tb/simple-calc
Fix fatal exceptions in samples/simple-calc.rb

Couldn't handle bad input

Changelog: bugfix