List of emoji for git commits. 💥
Interesting idea from the Atom.io contributing docs.
Consider starting the commit message with an applicable emoji
This idea was orinially based on Atom.io contrib docs... Though, apparently not in current guide. Other examples are kinda interesting with code available online. Also worth checking out:
- https://github.com/tjoskar/gitmoji-commit-hook
- https://github.com/openhwgroup/cva6/blob/master/CONTRIBUTING.md
- https://gist.github.com/MadcapJake/04a32b4e903a1ae0774e
Be a good collaborator. Communicate the context about a change.
➡️ Read More and more
- The first word should be an UPPERCASE action label and/or emoji
- Then, Capitalize the subject line
- Use the imperative mood in the subject line. Fix, Add, Change instead of Fixes, Added, Changing.
- Limit the subject line to 50 characters
- Do not end the subject line with a period
- Separate subject from body with a blank line
- Use the body to explain what and why vs. how
- Wrap the body at 72 characters
- Why is this change necessary? It may fix a bug, it may add a feature, it may improve performance, reliabilty, stability, or just be a change for the sake of correctness.
- How does it address the issue? For short obvious patches this part can be omitted, but it should be a high level description of what the approach was.
- What side effects does this change have? (In addition to the obvious ones, this may include benchmarks, side effects, etc.)
Pro-tip: Format subject line:
<emoji or ACTION:> <50 character synopsis of change>
| Emoji | Markdown | Commit action label |
|---|---|---|
| BASIC | ||
| ✨ | :sparkles: |
ADD / feature |
| 🙈 | :see_no_evil: |
ADD / UPDATE gitignore |
| 💩 | :poop: |
ADD / poor/quick code |
| 🐛 | :bug: |
BUGFIX |
| 🔧 | :wrench: |
CHANGE / re-TOOL |
| 🚑 | :ambulance: |
CRITICAL HOTFIX |
| 🚀 | :rocket: |
DEPLOY (build) |
| 🌱 🐣 | :seedling: :hatching_chick: |
INIT |
| 🔀 | :twisted_rightwards_arrows: |
MERGE |
| ❌ | :x: |
REMOVE |
| DETAILED | ||
| ➕ | :heavy_plus_sign: |
ADD (new api) |
| 🎨 | :art: |
ADD/CHANGE (UI code) |
| 💄 | :lipstick: |
ADD/CHANGE (cosmetic / lint) |
| ♻️ 🏗️ | :recycle: :building_construction: |
CHANGE (refactor) |
| 🐎 | :racehorse: |
CHANGE (streamline) |
| ⚡ | :zap: |
CHANGE (improve performance) |
| 📝 | :memo: |
DOC |
| 🚚 | :truck: |
MOVE / RENAME |
| 📛 | :name_badge: |
METADATA |
| ©️ | :copyright: |
LICENSE |
| 🎉 | :tada: |
INIT ( begin project ) |
| 🌐 | :globe_with_meridians: |
INTERNATIONALIZATION |
| 💀 | :skull: |
REMOVE (depreciate api) |
| ⏪ | :rewind: |
REVERT |
| ❔ | :white_check_mark: |
TEST |
 |
:shipit: |
VERSION |
| 🚧 | :construction: |
WIP |
| Shell Command | Result |
|---|---|
git commit -m ":bug: BUGFIX: Foo bar baz ipsum blah in lorem" |
🐛 BUGFIX: Foo bar baz ipsum blah in lorem |
git commit -m ":sparkles: Add new baz ipsum blah" |
✨ Add new baz ipsum blah |
- https://who-t.blogspot.co.at/2009/12/on-commit-messages.html
- https://chris.beams.io/posts/git-commit/#tips
- http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
- https://github.com/erlang/otp/wiki/writing-good-commit-messages
- https://gist.github.com/rxaviers/7360908
- https://github.com/dannyfritz/commit-message-emoji