Git Academy

Débutant · 4 min de lecture

Écrire des commits dont ton équipe te remerciera

« fix », « wip », « final final v2 »… On peut faire mieux, en cinq minutes.

Un commit, une idée

Un commit doit pouvoir être annulé seul. Mélanger un correctif, un renommage et du formatage rend la relecture et l'annulation pénibles. N'indexe que ce qui va ensemble.

Sans risque
$ git add -p

Un message qui explique pourquoi

Le diff dit déjà ce qui a changé. Le message doit dire pourquoi. Première ligne courte (moins de 72 caractères), à l'impératif, détails dans le corps si besoin.

Sans risque
$ git commit -m "fix(auth): refresh the session before it expires"

Conventional Commits

Des préfixes comme feat:, fix:, docs: rendent l'historique lisible d'un coup d'œil et permettent des changelogs automatiques. Notre assistant de commit dans la Toolbox les construit pour toi.