Skip to content

Instantly share code, notes, and snippets.

@joshsmith
Created March 1, 2016 18:26
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save joshsmith/e9174e0d15975c0cff08 to your computer and use it in GitHub Desktop.
Save joshsmith/e9174e0d15975c0cff08 to your computer and use it in GitHub Desktop.
Doing a git rebase and squash

If you've had a pull request reviewed and accepted, congratulations! Before we can merge your changes, we'll need you to rebase off origin/develop and squash your commits into one. This will give us a cleaner git history.

Never done this before? No problem. We'll walk you through it, and you can read a deeper guide about rewriting history to understand more.

On your command line you'll want to do:

git rebase -i origin/develop

This says to rebase your work off of develop. If you use an editor like Sublime Text, you'll want to be sure your editor doesn't close without a response.

From here, you'll see something like:

pick f48d47c The first commit I did
pick fd4e046 The second commit I did

You'll want to change everything after your first commit from pick to squash. This tells git you want to squash these commits into the first one.

From here, you'll get an editor that will let you change the commit messages.

# This is a combination of 2 commits.
# The first commit's message is:
The first commit I did

# This is the 2nd commit message:

The second commit I did

You'll want to remove or comment out everything except for the first message, which you can edit to be a more complete summary of your changes.

To finish, you'll force push this new commit with the following command:

git push origin [my-feature-branch] --force-with-lease

The --force-with-lease flag will refuse to update a branch if nobody else has updated it upstream, making your force push a little safer.

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