Cleaning Up Your Git History with Interactive Rebase

The Problem: The 'Work-in-Progress' Noise

\n

Most developers commit frequently. You might have commits titled \"save point,\" \"fixing typo,\" or \"trying one more thing\" scattered across a feature branch. While these are helpful during active development, they create noise in the project history. When a teammate reviews your Pull Request or a lead looks back at the logs to find where a bug was introduced, these micro-commits obscure the actual logic of the change.

\n

The goal is to present a clean, linear history where each commit represents a single, logical unit of work. Git's rebase -i (interactive rebase) allows you to rewrite your local history to achieve this before your code ever hits the main branch.

\n\n

How Interactive Rebase Works

\n

Interactive rebasing is essentially a way to tell Git: \"I want to go back to a specific point in time and rewrite everything that happened after it.\" When you trigger an interactive rebase, Git opens a temporary text file (the TODO list) in your configured editor. This file lists every commit between your current state and the target commit.

\n

Each commit is prefixed with a command. The default is pick, which tells Git to keep the commit as is. However, you can change pick to several other actions:

\n

\n
• Reword: Keeps the commit's changes but lets you edit the commit message.
\n
• Squash: Melds the commit into the previous one and prompts you to combine the messages.
\n
• Fixup: Like squash, but it discards the commit message of the current commit, keeping only the previous one.
\n
• Drop: Completely removes the commit from the history.
\n

\n\n

Worked Example: Consolidating a Feature Branch

\n

Assume you are on a feature branch and have three commits that should actually be one clean feature implementation. You can run this command from your terminal (requires Git 2.x+):

\n\n

# Rebase the last 3 commits on the current branch\n git rebase -i HEAD~3

\n\n

Your editor will open a file looking like this:

\n

pick a1b2c3d Initial feature implementation\npick e4f5g6h Fix typo in variable name\npick i7j8k9l Add missing unit test for edge case

\n\n

To consolidate these into one commit, change the actions to fixup (or f) for the noise commits:

\n

pick a1b2c3d Initial feature implementation\nfixup e4f5g6h Fix typo in variable name\nfixup i7j8k9l Add missing unit test for edge case

\n\n

Save and close the editor. Git will now apply the changes from the second and third commits directly into the first. To verify the result, run:

\n

git log --oneline

\n\n

You should now see only one commit instead of three, with the history reflecting the final state of the code rather than the trial-and-error process.

\n\n

The Critical Trade-off: Public vs. Private History

\n

Interactive rebasing changes the commit hashes. Because Git identifies commits by their SHA-1 hash, rewriting a commit creates a brand new object. This leads to a significant risk: never rebase commits that have already been pushed to a shared public branch.

\n

If you rewrite history that others have already pulled, their local history will diverge from the remote. When they try to pull again, Git will attempt to merge the two versions of the same changes, resulting in a \"duplicate commit\" nightmare and complex merge conflicts.

\n

If you must update a remote feature branch after a rebase, avoid git push --force. Instead, use:

\n

git push --force-with-lease

\n

This command checks if the remote branch has been updated by someone else since your last fetch. If it has, the push will fail, preventing you from accidentally overwriting a colleague's work.

\n\n

Final Checklist for a Clean History

\n

\n
• Local only: Only rebase commits that exist on your local machine or your private feature branch.
\n
• Atomic commits: Use squash and fixup to ensure each commit in the final history is a complete, working change.
\n
• Verify: Always run your test suite after a rebase to ensure that reordering or dropping commits didn't introduce a regression.
\n