Si vous travaillez sur des projets qui nécessitent un minimum de suivi dans le temps, vous utilisez sûrement git.
Depuis 2022, j’utilise le standard de commit EMOJI-LOG, inventé par Ahmad Awais. Le principe part du constat simple : il n’existe pas des centaines de raisons pour faire un commit. Nouvelle feature, amélioration, fix… Ahmad Awais liste sept motifs, auquel j’ajoute l’update de dépendance.
Afin de rendre l’historique des commits plus visuel, le standard EMOJI-LOG propose de préfixer nos commits par un emoji représentatif du motif de commit.
Voici les différents motifs
| 📦 NEW: | Nouvelle fonctionnalité |
| 👌🏼 IMPROVE: | Amélioration du code, refactor… |
| 🐛 FIX: | Correction de bug |
| 🚀 RELEASE: | Nouvelle release |
| 📖 DOC: | Ajout de documentation |
| 🔄 UPDATE: | Mise à jour de dépendance |
| 🤖 TEST: | Ajout ou mise à jour de tests |
| ‼️ BREAKING: | Changement qui casse la rétrocompatibilé |
Pour ne pas avoir à chercher loin nos emojis, il est possible d’ajouter des alias afin de de n’avoir à taper que git new 'commit message'.
Voici mes alias pour l’utilisation de l’EMOJI-LOG
[alias]
# EMOJI-LOG
# See https://github.com/ahmadawais/Emoji-Log
# Git Commit —m.
ci = commit -m
# NEW.
new = "!f() { git ci \"📦 NEW: $@\"; }; f"
# IMPROVE.
imp = "!f() { git ci \"👌🏼 IMPROVE: $@\"; }; f"
# FIX.
fix = "!f() { git ci \"🐛 FIX: $@\"; }; f"
# RELEASE.
rlz = "!f() { git ci \"🚀 RELEASE: $@\"; }; f"
# DOC.
doc = "!f() { git ci \"📖 DOC: $@\"; }; f"
# LIBRARY UPDATE
upd = "!f() { git ci \"🔄 UPDATE: $@\"; }; f"
# TEST.
tst = "!f() { git ci \"🤖 TEST: $@\"; }; f"
# BREAKING CHANGE.
brk = "!f() { git ci \"‼️ BREAKING: $@\"; }; f"
# emoji-log commit help
emoji = "!f() { \
echo \" git new\t📦 NEW: Use when you add something entirely new.\"; \
echo \" git imp\t👌🏼 IMPROVE: Use when you improve/enhance piece of code like refactoring etc.\"; \
echo \" git fix\t🐛 FIX: Use when you fix a bug.\"; \
echo \" git doc\t📖 DOC: Use when you add documentation like README.md, or even inline docs.\"; \
echo \" git upd\t🔄 UPDATE: Use when you update a library, like composer update\"; \
echo \" git rlz\t🚀 RELEASE: Use when you release a new version.\"; \
echo \" git tst\t🤖 TEST: Use when related to testing.\"; \
echo \" git brk\t‼️ BREAKING: Use when releasing a change that breaks previous versions.\"; \
}; f"