I find it tedious to write commit messages. The common practice is to use a verbose commit message, where the first word is a verb describing what the commit did do, for example:
Add editable title on <ArticleEdit /> componentHotifx: Handle authentication failed for expired tokenFix typo in about us pageRemove unused css
I propose here a new syntax I'm using that makes thing easy to understand later and to write.
It's based on 4 symbols:
+ADD-REMOVE/STRIP*REVIEW/CORRECT/FIX!HOTFIX
So, here are the examples messages above, rewritten with the proposed syntax style:
+ editable title in <ArticleEdit>! expired token in Authentication* typo in about us page- unused css
By forcing to use those symbols (and/or integrating your own), I clearly see some advantages:
- Navigate and search
git logeasier - Easily extrapolate stats and analysis from commit history
- Think less about commit message
- Remove the use of synonyms
What do you think about?