This comprehensive guide explores everything you need to know about the COMMIT_EDITMSG file, how Git uses it, how to customize it, and how to troubleshoot common issues when it gets stuck. What is COMMIT_EDITMSG ?
To a beginner, Vim can be confusing because it does not allow direct typing upon opening. If your terminal screen changes to display COMMIT-EDITMSG at the top and rows of tildes ( ~ ) down the side, you are inside Vim. How to Save and Exit Vim: Press the key to ensure you are in Command Mode. Type :wq (which stands for write and quit). Press Enter . Your commit will save and complete. How to Cancel and Exit Vim: Press the Esc key. Type :q! (which forces a quit without saving). Press Enter . The commit will abort safely. How to Change the Default Editor for Git
This hook fires before the editor opens. You can use it to dynamically inject text into COMMIT-EDITMSG . For example, a script can read your current Git branch name (such as jira-123-fix-bug ) and automatically prepend the ticket number ( [JIRA-123] ) to the top of the file, saving you manual typing. COMMIT-EDITMSG
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:
: Writing a 300-character sentence on a single line in the body. Result : It breaks git log formatting and looks unprofessional in GitHub diffs. Fix : Manually wrap at 72 characters or configure your text editor to do it for you (Vim: set textwidth=72 ). This comprehensive guide explores everything you need to
When you first open COMMIT-EDITMSG , you will see a mix of empty space and commented lines.
had just finished a marathon coding session, finally squashing the bug that had haunted the repository for weeks. He typed the command with a sense of triumph: git commit If your terminal screen changes to display COMMIT-EDITMSG
COMMIT_EDITMSG is a temporary file automatically generated by Git inside the .git directory (specifically at .git/COMMIT_EDITMSG ). Its sole purpose is to for a commit that is in progress.
: Write the subject line as if giving a command. Say "Fix login timeout bug" instead of "Fixed login timeout bug" or "Fixes login timeout bug" .