Skip to content

git stash

git stash sits at the heart of stashing in Git. This guide walks through the concept step by step, with examples, a cheatsheet, and common mistakes to avoid.

git stash Overview

At its core, git stash is about doing one thing well in Git. Once you understand the pattern, you can apply it consistently across projects and teams.

Good git stash pays off across the whole project: fewer surprises, easier collaboration, and smoother onboarding. The snippet below is a solid starting point.

# save uncommitted work temporarily
git stash

# do other work, then restore it
git stash list
git stash pop

Stashing shelves your uncommitted changes so you can switch context and restore them later.

git stash Example

git add <files>
git commit -m "message"
git push origin <branch>
  • Start from a minimal git stash example and grow it only as needed.
  • Keep things explicit so git stash behaves the same for everyone on the team.
  • Name things clearly so teammates understand your git stash at a glance.
  • Verify git stash works as expected before relying on it in important work.

Git Cheatsheet

Handy Git command reference related to git stash.

Task Command Purpose
Status git status See what changed
Stage git add <file> Prepare changes to commit
Commit git commit -m "msg" Record a snapshot
Branch git switch -c name Create and switch branch
Merge git merge branch Combine histories
Push git push origin main Share commits
Pull git pull origin main Get others' commits
Undo git restore <file> Discard local changes

How git stash Works in Git

git stash builds on Git's model of snapshots and references. Every commit points to a full snapshot of your project, and branches are simply lightweight pointers to commits.

Stashing shelves your uncommitted changes so you can switch context and restore them later.

  • The working directory, staging area, and repository are Git's three main areas.
  • Commits are immutable snapshots linked to their parents.
  • Branches and tags are just pointers to commits.
  • Remotes are copies of the repository you sync with.

Practical Guidance for git stash

On real teams, git stash works best with small, focused commits and clear messages. Commit often, write descriptive messages, and pull before you push to avoid surprises.

Habit Why it helps
Small commits Easier to review and revert
Clear messages History explains the why
Branch per feature Isolates work in progress
Pull before push Avoids avoidable conflicts

Common Mistakes

  • Skipping edge cases and error handling when using git stash.
  • Not verifying the result of git stash before moving on.
  • Over-complicating git stash before you actually need the extra flexibility.
  • Ignoring documentation, which makes git stash hard for the next person to follow.

Key Takeaways

  • git stash is a core part of working effectively with Git.
  • Start small and keep git stash focused on a single goal.
  • Apply consistent patterns so git stash scales across your project.
  • Practise and document git stash to keep your workflow maintainable.

Pro Tip

Bookmark this git stash pattern and reuse it. Consistency across your Git work is worth more than clever one-off solutions.