The format is: <type>(<scope>): <description>
Every time you run git commit without the -m flag, your terminal pauses, and a text editor opens. At the top of that window, you might notice a strange file name in a temporary directory: COMMIT-EDITMSG .
If you have ever peeked into your project's .git folder, you have likely seen a file named COMMIT_EDITMSG . Most developers ignore it, but understanding this file is the secret to fixing failed commits, creating consistent templates, and automating your workflow.
: Every line starting with a # character is injected by Git as a helpful reminder of your current repository state. These lines are completely ignored by Git when creating the actual commit log. How Git Processes COMMIT_EDITMSG
: If you close the file without saving text, or leave it completely empty, Git cancels the commit. The Anatomy of a COMMIT-EDITMSG File COMMIT-EDITMSG
: Tell Git to use it:
Keep it under 50 characters. Use the imperative mood (e.g., "Fix bug" instead of "Fixed bug" or "Fixes bug"). Blank Line: Always leave a blank line between the subject and the body. The Body (The Context): Explain the of the change, rather than the . Wrap these lines at 72 characters for readability. 2. Save and Exit Git waits for the COMMIT_EDITMSG
One of the most underutilized features of Git is the commit.template configuration.
The true power of COMMIT-EDITMSG emerges when combined with Git Hooks—scripts that run automatically at specific points in the Git workflow. The commit-msg Hook Most developers ignore it, but understanding this file
To keep your project history clean, follow the "50/72 rule":
: Git checks the file. If the file is empty or unchanged from its default template state, Git aborts the commit. If it contains text, Git cleans up the comment lines, saves the text into the commit history, and the COMMIT_EDITMSG file rests until the next commit. Customizing Your Commit Workflow via COMMIT_EDITMSG
You can use this hook to automatically populate COMMIT_EDITMSG with ticket numbers, templates, or branch names.
file provides the context needed to understand complex architectural decisions. Pro-Tips for Using COMMIT_EDITMSG Configure Your Editor : You can change which editor opens this file by running git config --global core.editor "code --wait" (for VS Code) or your preferred tool. Commit Templates : You can create a permanent template for your COMMIT_EDITMSG How Git Processes COMMIT_EDITMSG : If you close
mentions that this hook is vital when the default message is auto-generated. 3. Recovering Lost Messages
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
Fix authentication timeout bug on login screen # Please enter the commit message for your changes. Lines starting # with '#' will be ignored, and an empty message aborts the commit. # # On branch main # Your branch is up to date with 'origin/main'. # # Changes to be committed: # modified: src/auth.js # modified: src/login.js # Use code with caution.