This intercepts your commit message and converts to the predefined template.
- Download
install.sh
,.commit-message-templates
. - Place two files in the your repository path.
- Execute
install.sh
. - Customize
.commit-message-templates
to your rule. - Commit with message like
{keyword}|{message}
.
Content of .commit-message-templates
is consist of three part.
keyword
, gitmoji
, type
.
Here is example.
keyword,gitmoji,type // DO NOT EDIT THIS
bug,π,Fix
imp,β‘οΈ,Improve
mg,π,Merge
acf,π§,Add
ucf,π§,Update
These templates mean the following table.
keyword | gitmoji | type |
---|---|---|
bug | π | Fix |
imp | β‘οΈ | Improve |
mg | π | Merge |
acf | π§ | Add |
ucf | π§ | Update |
bug|{message}
=>π Fix: {message}
imp|{message}
=>β‘οΈ Improve: {message}
mg|{message}
=>π Merge: {message}
acf|{message}
=>π§ Add: {message}
ucf|{message}
=>π§ Update: {message}
git commit -m "imp|performance for data validation"
This message will be converted to β‘οΈ Improve: performance for data validation
.
git commit -m "improve|performance for data validation"
If improve
is undefined keyword
in the template, the commit fails.