This chart is greatly inspired by dannyfritz/commit-message-emoji
In general, the rule that is imposed is:
A good commit message should let you know what has changed and why . How those changes has been made does not need to be explained. Reading the code and highlighting changes via a diff is self-explanatory.
However, when browsing a long list of commits you may get lost and not find the changes you want, which is why there are "standards" to know the type of commit this can be text or, in this case, emotes
So this is what the commit message should look like:
<type emote> <title> [<description (not mandatory)>]
//Exemple
๐ Fix infinite loopIt is of course quite possible to 'cumulate' types if your commit falls into several categories.
It is however mandatory to remember that a commit should only represent one change.
| Commit Type | Emote | Code |
|---|---|---|
| Initial Commit | ๐ | :tada: |
| Work in progress | ๐๏ธ or ๐ง | :building_construction: or :construction: |
| Bug fix | ๐ฉน | :adhesive_bandage: |
| Forgotten .meta or inspector links / Metadata | ๐ | :card_index: |
| Critical bug fix | ๐ | :ambulance: โ |
| Merge branches | ๐ | :twisted_rightwards_arrows: |
| Merge without conflicts | ๐ | :trophy: |
| Deleting code or files | ๐ฅ | :fire: |
| Shitty stuff that needs rework | ๐ฉ | :poop: |
| Working while being under the influence of drugs or alcohol | ๐ป | :beers: |
| Adding or upgrading external packages | ๐ฆ | :package:โ |
| Commit Type | Emote | Code |
|---|---|---|
| New Feature | โจ | :sparkles: |
| Writing documentation | ๐ | :books: |
| Re-factor of code | โป๏ธ | :recycle: |
| Improve performance | ๐ด | :horse: |
| Create tool | ๐ง | :wrench: |
| Security Fix | ๐ | :lock: |
| Removing linter warning | ๐จ | :rotating_light:โ |
| Releasing / Version tags | ๐ | :bookmark:โ |
| Commit Type | Emote | Code |
|---|---|---|
| Add/Update Models | ๐ฟ | :moyai: |
| Add/Update Texture or Sprite | ๐จ | :art: |
| Add/Update Animations | ๐ | :runner: |
| Add/Update Shaders/Materials | ๐ต๏ธ | :rosette:โ |
| Add/Update VFX | ๐ | :sparkler: |
| Commit Type | Emote | Code |
|---|---|---|
| Working on level design | ๐บ๏ธ | :world_map: |
| Tweaking some game values | โ๏ธ | :gear: |
| Add/Update User interfaces | ๐ | :lipstick:โ |
| Commit Type | Emote | Code |
|---|---|---|
| Add/Update on Sound Design | ๐ | :loud_sound: |
| Add/Update on Musics | ๐น | :musical_keyboard:โ |
| Ingame sound integration | ๐ถ | :notes: |