Formations — 1 037 leçons en français

Accueil › Git & CI/CD › Écrire un commit qui servira dans six mois

Écrire un commit qui servira dans six mois

Les basesdebutant

Un commit sert deux fois : aujourd'hui, pour enregistrer. Et dans six mois, quand quelqu'un — probablement vous — cherchera pourquoi cette ligne existe.

La forme :

Corriger le total quand le panier est vide

reduce() sans valeur initiale lève sur un tableau vide, ce qui
cassait la page panier après suppression du dernier article.

Signalé par le support, ticket #4821.

Sujet à l'impératif, court, sans point final. Ligne vide. Puis le pourquoi — le quoi se lit dans le diff, le pourquoi ne se lit nulle part ailleurs.

Le contenu : une seule chose à la fois. Un commit qui corrige un bug et renomme trois variables et met à jour une dépendance est impossible à annuler proprement.

git log --oneline -5
a3f91c2 Corriger le total quand le panier est vide
7d2e8b1 Ajouter le bouton « Vider le panier »

Ce n'est pas de l'esthétique. Trois outils en dépendent directement :

Les termes à connaître

Message de commit

Ligne de sujet courte à l'impératif, puis, si nécessaire, un corps séparé par une ligne vide qui explique pourquoi. Le quoi se lit dans le diff ; le pourquoi ne se lit nulle part ailleurs.

Commit atomique

Commit qui fait une seule chose et laisse le projet dans un état cohérent. C'est la condition pour que revert, cherry-pick et bisect servent à quelque chose.

Conventional Commits

Convention qui préfixe le sujet par un type : feat:, fix:, docs:, refactor:, test:, chore:. Permet d'engendrer un journal des versions et de déduire le numéro de version automatiquement.

git log

Affiche l'historique. --oneline pour le survol, --graph pour voir les branches, -p pour les différences, -S"texte" pour retrouver le commit qui a introduit une chaîne précise.

git bisect

Recherche dichotomique du commit qui a introduit un bug. Sur mille commits, dix essais suffisent — à condition que chaque commit laisse le projet dans un état fonctionnel.

git blame

Indique, pour chaque ligne d'un fichier, le commit qui l'a écrite en dernier. Sert à retrouver le contexte d'une ligne incompréhensible, pas à désigner un coupable.

Lire l'explication détaillée et faire le quiz →

Cette page présente la partie essentielle de la leçon. Les exemples commentés, les pièges courants et les trois questions de quiz sont dans l'application.