🎯 Intention

Le but est rendre les commit lisible dans le but de rendre les merge request lisible et permettre de suivre l’évolution du projet via l’historique git.

<aside> ✅ Pré-requis

• Outils (Déjà installés par le standard : ‣)
  • git
  • VSCode + extension (VSCode Gitmoji)
  • ET/OU - gitmoji-cli (https://gitmoji.dev/about)
• Projet correctement cloné (Git : Cloner un projet avec une clé SSH) </aside>

✅ Point clés

<aside> ⌛ Temps indicatif: < 5min

</aside>

Etape

Visuel / Exemple

🛠️ 1.  Initialiser le commit

• Méthode 1 : Console

  Installation :

  • yarn i -g gitmoji-cli ou brew install gitmoji
  • Configurer le gitmoji avec gitmoji -g

  Usage :

  • Ajouter les fichiers 1 à 1 git add {file}
  • Ligne de commande gitmoji -c

• Méthode 2 : VSCode

  • Menu de gauche > “Source Control”

    

  • Ajouter les fichiers 1 à 1 avec le bouton ➕

⚠️ Eviter de faire d’ajouter tous les fichiers d’un coup ( git add -a )

Exemple avec gitmoji-cli

Exemple avec VSCode

📝 2. Ecrire un message de commit correctement formaté

• 😀 Un Gitmoji dans la liste (utiliser un emoji par un code) ✓ : 🐛  ✗ : :bug:
  • Raison
• 📝  Première ligne de 100 caractères max.
  • Raison
• 💬  Commencer par un verbe à l’impératif ✓ : “Ajoute la fonctionnalité XXX” ✗ : “J’ai ajouté la fonctionnalité XXX”
  • Raison
• 🔠 Commencer par une majuscule ✓ : “Ajoute XXX” ✗ : “ajoute XXX”
  • Raison
• 🇫🇷 En français ✓ : “Ajoute XXX” ****✗ : “Add XXX”
  • Raison

⚠️ Si un commit semble correspondre à plusieurs gitmoji, c’est qu’il n’est pas atomique, il faut le diviser.

<emoji> <description>
(blank line)
[optional body]
(blank line)
[optional footer(s)]

Exemples de messages de commit

♻️ Refactorise le service Facturation

✨ Ajoute la fonctionnalité de Remboursement

- Ajoute un bouton dans le formulaire
- Ajoute une nouvelle API REST /remboursement

Reviewed-by: Z
Refs: #123

❌ Erreurs type à éviter

• Utiliser le gitmoji afin de décrire le moyen au lieu du BUT. Si on met a jour une dépendance a cause d’une faille de sécurité on prendra 🔒 (fix security) plutôt que ⬆️ (upgrade dependency)

• Etre incohérence des gitmoji entre les commits. En cas de doute faut se référer à l’annexe des listes d’emojis ici .

• Perdre progressivement la qualité des messages

  • Exemple

• Ne pas avoir set l’autoremote :

  https://pawelgrzybek.com/auto-setup-remote-branch-and-never-again-see-an-error-about-the-missing-upstream/

• Utiliser l’option wait à la configuration de Visual Studio Code pour Git :

  git config --global core.editor "code --wait" Plus d’information ici