Are you weary 😩 of shitty commit messages like
Bugfix.
Refactor stuff.
Delete old code.
Behold! Here is a simple solution. Use the .gitmessage template provided in this repository to nudge your colleagues
(and yourself) into writing better commit messages like
🐛 Fix bug in data loader causing an IndexError.
♻️ Refactor database integration.
✂️ Removed old routing logic.
If you want to set this commit template globally, clone the repo or download the .gitmessage file and run
git config commit.template /absolute/path/to/file
If you want to set this commit template for a single repository, run
git config commit.template relative-path-from-repository-root
When working on your project, just call the usual
git commit
and the template pops up. Don't worry, every line starting with # is a comment and will not be visible.
This particular template was created in collaboration with @dieuwkehupkes and @jumelet on this project.
The emoji system is loosely adapted from @dannfritz's system, which can be found here.
Instructions on how to set the template was found on this StackOverflow question.
A complete list of emojis that are supported by GitHub can be found here.