Skip to content

Instantly share code, notes, and snippets.

@davidrapin
Created March 22, 2016 15:31
Show Gist options
  • Select an option

  • Save davidrapin/cfa5131be3258975df3f to your computer and use it in GitHub Desktop.

Select an option

Save davidrapin/cfa5131be3258975df3f to your computer and use it in GitHub Desktop.

In order to keep this easy to navigate, it is asked that you squash your commits down to a few, or one, discreet changesets before submitting a pull request. Fixing a bug will usually only need one commit, while a larger feature might contain a couple of separate improvements that is easier to track through different commits.

Once you have rebased your work on top of the latest state of the upstream master, you may have several commits related to the issue you were working on. Once everything is done, squash them into a single commit with a descriptive message, like "Issue #100: Retweet bugfix."

To squash four commits into one, do the following:

$ git rebase -i HEAD~4

In the text editor that comes up, replace the words "pick" with "squash" next to the commits you want to squash into the commit before it. Save and close the editor, and git will combine the "squash"'ed commits with the one before it. Git will then give you the opportunity to change your commit message to something like, "Issue #100: Fixed retweet bug."

_**Important: If you've already pushed commits to GitHub, and then squash them locally, you will have to force the push to your branch.

$ git push origin branch-name --force

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment