README.md

Git Commit Message Converter

This intercepts your commit message and converts to the predefined template.

Getting Started

1. Download install.sh, .commit-message-templates.
2. Place two files in the your repository path.
3. Execute install.sh.
4. Customize .commit-message-templates to your rule.
5. Commit with message like {keyword}|{message}.

Customizing templates

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}

Examples

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.