# <type>(<scope>): <subject> (max 50 chars) # |<---- using Conventional Commits ---->| # # <body> Explain *what* and *why*, not *how*. (72 chars max) # # <footer> Any closing notes or breaking changes. # # --- Commits will be signed off with your user.email --- Now, every time you run git commit , your editor opens with this custom template inside COMMIT-EDITMSG . It acts as a checklist, dramatically improving consistency across teams. "Aborting commit due to empty commit message." You saved an empty file, or a file with only comments ( # ). Git reads COMMIT-EDITMSG , strips comments, and sees nothing. Fix: Run git commit again and write a message. Editor opens but COMMIT-EDITMSG is missing. Your $EDITOR environment variable is misconfigured, or your editor crashed. Check with echo $EDITOR . Fix: git config --global core.editor "nano" (or your preferred editor). A hook is rejecting my commit, but I need to bypass it. You can bypass commit-msg hooks with --no-verify :
If you have ever typed git commit without the -m flag, you have interacted with this file. You might have thought you were just using a text editor to write a message. In reality, you were editing a temporary file named COMMIT-EDITMSG .
git config --global commit.template ~/.gitmessage.txt Create ~/.gitmessage.txt : COMMIT-EDITMSG
Located in .git/hooks/commit-msg (or .git/hooks/commit-msg.sample to start), this script can read, validate, or even modify the COMMIT-EDITMSG file before the commit is finalized. You want every commit message to follow the Conventional Commits standard (e.g., feat: add login , fix: resolve null pointer ).
Using a prepare-commit-msg hook (a cousin that runs before the editor opens), you can read the branch name and append the ticket to COMMIT-EDITMSG : It acts as a checklist, dramatically improving consistency
Understanding this file transforms you from a casual Git user into a Git power user. It is the gateway to crafting perfect commit history, automating quality checks, and integrating seamlessly with modern AI tooling. The COMMIT-EDITMSG file is a transient, temporary file created by Git in the .git/ directory (specifically, .git/COMMIT_EDITMSG ) whenever you initiate a commit that requires an editor. Its sole purpose is to hold the commit message for the commit currently in progress.
git commit --no-verify -m "Hotfix for production" Warning: Use sparingly. This is a nuclear bypass for emergency situations. It's easy to confuse COMMIT-EDITMSG with other .git files: Fix: Run git commit again and write a message
In the world of Git, much of the spotlight falls on commands like commit , push , merge , and rebase . Developers boast about their aliases, their branching strategies, and their elegant use of interactive rebasing. Yet, nestled quietly in the .git folder of every repository lies a humble, often-overlooked file: COMMIT-EDITMSG .