https://github.com/kaleidophon/commit-template-for-humans
An approachable git message template for normal people, including instructions on how to set it up.
https://github.com/kaleidophon/commit-template-for-humans
commit commit-conventions commit-message emojis git github gitmessage
Last synced: about 2 months ago
JSON representation
An approachable git message template for normal people, including instructions on how to set it up.
- Host: GitHub
- URL: https://github.com/kaleidophon/commit-template-for-humans
- Owner: Kaleidophon
- License: mit
- Created: 2019-02-20T19:11:44.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-04-27T17:43:03.000Z (about 4 years ago)
- Last Synced: 2025-02-08T09:46:59.056Z (3 months ago)
- Topics: commit, commit-conventions, commit-message, emojis, git, github, gitmessage
- Homepage:
- Size: 4.88 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# A commit message template for humans :family:
## What is this about? :interrobang:
Are you weary :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
---
:bug: Fix bug in data loader causing an IndexError.
---
:recycle: Refactor database integration.
---
:scissors: Removed old routing logic.
---
## How do I use this? :computer:
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.
## Credit where credit is due :clap:
This particular template was created in collaboration with [@dieuwkehupkes](https://github.com/dieuwkehupkes) and [@jumelet](https://github.com/jumelet) on [this](https://github.com/dieuwkehupkes/diagnosing_lms)
project.
The emoji system is loosely adapted from [@dannfritz](https://github.com/dannyfritz)'s system, which can be found [here](https://github.com/dannyfritz/commit-message-emoji).
Instructions on how to set the template was found on [this](https://stackoverflow.com/questions/21998728/how-to-specify-a-git-commit-message-template-for-a-repository-in-a-file-at-a-rel)
StackOverflow question.
A complete list of emojis that are supported by GitHub can be found [here](https://gist.github.com/rxaviers/7360908).