How to write a good commit message?

 

Step 1: Understand why commit messages matter

 

• Commit messages document the evolution of your project
• Good messages help teammates and your future self
• They enable tools to generate changelogs and track issues

 

Step 2: Know the anatomy of a commit message

 

• Subject line: A short summary (≤50 characters)
• Blank line: Separates subject from body
• Body: Detailed explanation, wrapped at 72 characters
• Footer (optional): Issue references or breaking changes

 

Step 3: Craft a concise subject line

 

• Use the imperative mood (e.g., “Add,” “Fix,” “Refactor”)
• Capitalize the first word
• Don’t end with a period

git commit -m "Add user login validation"

 

Step 4: Separate subject from body with a blank line

 

• The blank line improves readability
• Some tools expect exactly one blank line

Add user login validation

Implement checks for empty email and password fields.

 

Step 5: Explain what and why in the body

 

• Describe the “what” of the change—not the “how”
• Explain why the change was necessary
• Mention any trade-offs or side effects

Check both email and password inputs before submission.
Prevents server errors caused by missing fields.

 

Step 6: Wrap body text at 72 characters

 

• Keeps lines readable in terminals
• Helps diff tools display content neatly

Prevent null-pointer exceptions when user submits without filling
any input. Improves user experience and reduces backend errors.

 

Step 7: Reference issues and breaking changes in the footer

 

• Link to related issue IDs
• Note any breaking changes with “BREAKING CHANGE:”

Fix null-pointer on login submit

Handles missing input gracefully and returns validation errors
instead of server exceptions.

Resolves #42

 

Step 8: Use the proper Git commands

 

• Pass multi-line messages via an editor
• Use -m for simple commits
• Use -v to view diff in editor

git commit
# Opens your $EDITOR to write subject, blank line, body, footer

 

Step 9: Amend or squash commits when needed

 

• git commit --amend to update the last commit message
• Interactive rebase (git rebase -i) to squash or reorder commits
• Keep history clean before pushing to shared branches

 

Step 10: Review and proofread before pushing

 

• Check spelling and grammar
• Confirm subject/body alignment with guidelines
• Ensure issue references are correct