In our project, we create commits in an orderly way, using emoji for this and start the commit content with a capital letter. The commit body complements „this commit will...". For example: ":lipstick: Fix main container height"
| Text | Image | GFM shortcode* | Windows 10 picker name | When to use it |
|---|---|---|---|---|
🎉 |
🎉 | :tada: |
party popper |
initial commit |
✨ |
✨ | :sparkles: |
sparkles |
when adding a new user-facing feature |
🎨 |
🎨 | :art: |
artist palette |
when improving UI |
📦 |
📦 | :package: |
package |
when installing dependencies |
♻️ |
♻️ | :recycle: |
recycle |
when refactoring or improving code |
🐎 |
🐎 | :racehorse: |
horse |
when improving performance |
🔒 |
🔒 | :lock: |
locked |
when improving security |
🔧 |
🔧 | :wrench: |
wrench |
when updating configs |
♿ |
♿ | :wheelchair: |
wheelchair symbol |
when improving accessibility |
🚀 |
🚀 | :rocket: |
rocket |
when improving dev tools |
📝 |
📝 | :pencil: |
pencil |
when writing docs (e.g. README, code comments) |
💎 |
💎 | :gem: |
gem stone |
when cutting a new release / version bump |
🐛 |
🐛 | :bug: |
bug |
when fixing a bug |
💥 |
💥 | :boom: |
collision |
when fixing a crash |
🚱 |
🚱 | :non-potable_water: |
non-potable water |
when fixing a memory leak |
🔥 |
🔥 | :fire: |
fire |
when removing code or files |
✅ |
✅ | :white_check_mark: |
check mark button |
when adding new tests |
💚 |
💚 | :green_heart: |
green heart |
when fixing the CI build |
👕 |
👕 | :shirt: |
t-shirt |
when fixing linter warnings |
📡 |
📡 | :satellite: |
satellite antenna |
when adding instrumentation or metrics |
🔊 |
🔊 | :loud_sound: |
speaker high volume |
when adding logging |
🔇 |
🔇 | :mute: |
muted speaker |
when removing logging |
⬆ |
⬆️ | :arrow_up: |
up arrow |
when upgrading dependencies |
⬇ |
⬇️ | :arrow_down: |
down arrow |
when downgrading dependencies |
🎌 |
🎌 | :crossed_flags: |
crossed flags |
when adding an A/B test or feature flag** |
⚡ |
⚡ | :zap: |
high voltage |
when making a backwards-incompatible change** |
🚧 |
🚧 | :construction: |
construction |
when the change is a work in progress (do not merge)** |
In most cases, your change will fit into a pretty obvious emoji category. If it doesn't, you should think hard about whether or not you're making a clean change.
Often you can break up changes into two or more commits that each accomplish their own specific type of action. If that means you only change one tiny line or fix a simple typo in a commit, so be it! It should be a no-brainer that any given commit does exactly what it says it does — and only what is says it does. No side-effects.
In general, you should use exactly one emoji per commit message. In rare cases, you should use a second emoji (e.g. when using something like ⚡ to signify that whatever you just did — 🐛, 🔥, etc. — was a breaking change).
Emoji will also depend on your client/user. A back-end API might use ✨ when adding new API endpoints, and the front-end app might use ✨ when using those endpoints to display new content.
:[EMOJI_NAME]: [THE COMMIT WILL...]
:sparkles: Add cool animations:bug: Fix the flicker
[:]([A-Z a-z])\w+[:] [A-Z]\w.*$
RegEx example
🐛 Fix the flicker caused by the drawer✨ Add a super cool animation for the drawer♻️ Refactor drawer code🔥 Remove deprecated drawer code📦 Install react-littera@2.1.4