- Pourquoi il faut bien rédiger les messages de commit
- Des messages de commit cohérents et clairs aident les autres développeurs à les comprendre plus facilement
- Utiliser de bons messages de commit facilite le débogage des problèmes de code
- Des messages de commit Git bien rédigés transmettent le contexte des changements aux autres développeurs qui travaillent sur le projet, ainsi qu’à soi-même plus tard
- Comment rédiger un bon message de commit
- Indiquer au début le type de commit pour montrer de quel changement il s’agit
- Rédiger le message de commit en détail par considération pour les autres (
commit body utilisé)
- Utiliser un ton impératif ou de demande dans le message de commit
- Supprimer la ponctuation inutile
- Suivre la « convention de commit » définie par l’équipe
- La convention de commit de l’équipe produit d’Infograb
- Ajouter des émojis selon le type de commit pour le rendre plus lisible d’un coup d’œil
- Pour distinguer les composants, les pages et les fonctions, écrire les composants avec une majuscule, et les pages ainsi que les fonctions en minuscules
- Utiliser le
commit body pour ajouter des détails au commit
- Pour garder des messages de commit concis, abréger le mot « function » en « func »
2 commentaires
J’ai vraiment du mal à être d’accord avec l’idée que les emojis améliorent la lisibilité. Encore, s’il n’y en a que trois, à la rigueur...
Cet article est également intéressant.
https://chris.beams.io/posts/git-commit/
https://item4.github.io/2016-11-01/How-to-Write-a-Git-Commit-Message/