Générateur de messages de commit

Pourquoi un message de commit mérite une phrase aussi claire que le diff

Un excellent message de commit devrait ressembler à une phrase qu'un développeur viendrait de lire après une heure de débogage tranquille, juste avant de poser sa tasse. Le Codex du Conteur évoque des messages de commit fidèles à la tradition de la clarté conventionnelle, à l'idée d'un débogage futur et à l'atmosphère feutrée d'un dépôt que l'équipe peaufine discrètement depuis la dernière fusion.

La structure d'une phrase idéale pour un futur débogage

Les messages de commit s'inspirent des commits conventionnels, des préfixes de type et de la phonétique des dépôts modernes, avec une attention particulière portée à la portée ou à l'intention. Les messages de commit les plus mémorables se lisent comme une seule ligne d'un journal des modifications, le genre de ligne qu'un mainteneur souligne. Les rédacteurs associent un message à un marqueur de type ou de portée, ce qui donne déjà l'impression d'une équipe qui peaufine discrètement la même convention depuis deux ans.

Pour les flux de travail de dépôt, les scènes de développement sur table et les fanfictions de briefs de PR

Utilisez un message de commit pour amorcer un chapitre se déroulant dans un IDE silencieux, concevoir un flux de travail pour une partie unique sur table, nommer un commit pour une traduction amateur, donner vie à une réunion debout avec des voix crédibles, construire une lignée de mainteneurs, lancer une fanfiction où le bug est enfin résolu ou alimenter un brief de développeur avec des messages auxquels un développeur senior ferait confiance.

Conseils des rédacteurs de diff

Commencez par le type avant le titre. Un vrai message de commit commence par le type auquel appartient la modification. Laissez la portée de la syllabe. Les messages de commit doivent être suffisamment courts pour tenir sur une seule ligne. Alliez clarté et intention. Les meilleurs messages sont concis et légèrement explicatifs. Fiez-vous au marqueur de différence. Un type, une portée et une intention structurent le message. Soyez bref. Les responsables répondent par des messages de bienvenue concis.

Réfléchissez avant de vous lancer.

• De quelle convention de commit provient votre message : Commits conventionnels, Angular, Gitmoji, interne ou la vôtre ?
• Le message doit-il être formulé comme une correction, une fonctionnalité, une refactorisation, une tâche ou une documentation ? Le type est-il approprié ?
• Le message sera-t-il griffonné sur une PR, brodé sur un t-shirt ou murmuré dans une fanfiction ?
• Le marqueur de famille doit-il être un type, une portée ou une intention ?
• Écrivez-vous pour des workflows de dépôt, du développement sur table ou une fanfiction ? La différence est-elle pertinente ?