: It stores the last commit message you attempted to write. If your editor crashes or you cancel the commit, the text often remains in this file, allowing you to recover your work. Common Scenarios
Your project uses Jira (PROJ-123). You want every commit to include the ticket number, but you hate typing it. 30 seconds before you commit, you fetched the PROJ-123 branch.
A raw COMMIT-EDITMSG session forces you to adhere to this format, resulting in beautiful, git log --oneline and git shortlog friendly history.
It's essential to follow best practices for writing commit messages to ensure clarity and consistency in your repository's history. This typically includes: COMMIT-EDITMSG
fix: resolve user session timeout on dual-monitor setup
: You write your message, save the file, and close the editor.
Understanding the lifecycle of COMMIT_EDITMSG can be a lifesaver in specific scenarios: : It stores the last commit message you attempted to write
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 ?
[git commit] ──> Git creates .git/COMMIT-EDITMSG with boilerplate comments │ ▼ Git opens your default editor (e.g., Vim, VS Code) │ ▼ You write the message, save, and close the editor │ ▼ [Validation] ──> Git triggers 'commit-msg' hooks (if any exist) │ ▼ [Success] ──> Git creates the commit object using the file's text │ ▼ The text remains in .git/COMMIT-EDITMSG until the next commit Common Issues and How to Fix Them
When you save and close the editor, Git reads the contents of COMMIT_EDITMSG , strips out the comments, and uses the remaining text as the commit message. You want every commit to include the ticket
If you paste the actual contents of your COMMIT-EDITMSG , I will give you a with specific corrections.
Your commit message should read like a command. It answers the question: "If applied, what will this commit do?"
This isn't arbitrary. The 50-character limit ensures that the subject line fits comfortably in Git logs and GitHub/GitLab overviews. The 72-character body limit respects traditional terminal widths (80 columns), preventing scrolling and maintaining readability in git log outputs.