Dictionnaire anglais pour de bons messages de commit git
(blog.ull.im)« Les messages de commit réellement utilisés dans les projets sont d’une grande simplicité. Leur grammaire correspond à un niveau d’anglais de collège, et ils n’emploient pas non plus de mots difficiles. En fin de compte, la rédaction des messages du journal de commits doit être abordée non pas comme un exercice d’écriture, mais comme un ensemble de modèles. Il s’agit d’associer les caractéristiques de son commit à un modèle pour en extraire les mots appropriés. Vu comme un résultat rédactionnel, cela peut sembler trop simple et insuffisant, mais pour être facilement lu et compris par plusieurs personnes, des phrases simples et standardisées sont bien meilleures.
Malgré cela, écrire facilement des messages de commit reste difficile. Premièrement, il n’est pas simple de découper son travail en commits suffisamment petits pour pouvoir être expliqués en une seule phrase. Deuxièmement, il faut produire une phrase compréhensible pour un tiers qui la découvre pour la première fois, et non seulement pour son auteur. Après avoir saisi commit -m, lorsque la fenêtre de saisie du message apparaît, fermez les yeux, poussez un grand soupir et repassez en revue ce sur quoi vous avez travaillé. Puis essayez de choisir le meilleur mot possible. »
Aucun commentaire pour le moment.