Read on Twitter
Writing good Git commit messages matters!
A thread about how to write clean commit messages:
A thread about how to write clean commit messages:
Make your commit messages meaningful, explaining the reason for the change. The more explicit the message is, the more helpful it will be.Examples:
Don't:- fixed
- done
- added 2 class
Do:- add missing validation to login form
- fix bug for calculating cart price
Use the imperative moodImperative mood means that the commit message should be written as if giving a command or instruction.
Examples:
Don't:- I have implemented ...
- this commit will ...
- more fixes for broken stuff
Do:- add ...
- fix ...
- remove ...
Use present tenseGit commits can be checked out, merged, reverted or cherry-picked.
A properly formed Git commit line should be able to complete the following sentence:
- If applied, this commit will...
In order to complete this sentence, using present tense is needed.
Add link reference to the actual user story, task or bugIf you use project management tools such as Jira, GitLab or Azure DevOps then you can add the reference-id to the actual working item.
Template:
#<item-id>:<message>
Example:
#d342da: Fix bug on client validation
Commit length:Most of the time if you have long commit messages it means that you violate the following principle:
- Commit early & commit often
If you take baby steps and commit your work frequently, then you won't have issues with the commit length.
Tips for writing clean commit messages (sum up):- make your commit messages meaningful, explaining the reason for the change
- use the imperative mood
- use present tense
- add link reference to the actual user story, task or bug
- commit early & commit often
Enjoy!
