Commit-editmsg
The humble text file changes everything.
if ! grep -q -E "$pattern" "$message_file"; then echo "ERROR: Commit message does not follow Conventional Commits format." echo "Expected: <type>(<scope>): <subject>" echo "Example: feat(auth): add OAuth2 provider" exit 1 fi COMMIT-EDITMSG
# <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 : The humble text file changes everything
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 ). (72 chars max) # # <footer> Any closing
git commit -m "Fix bug in login flow" The -m flag is convenient for short messages, but it completely bypasses the COMMIT-EDITMSG workflow. This means you also bypass the powerful features that come with it: templates, hook validation, and multi-line editing. To truly appreciate the file, let's walk through a manual commit. Imagine you have staged changes. You run git commit . Your editor opens, and you see something like this: