Commits Conventionnels

Une spécification ajoutant une signification lisible pour l'humain et pour la machine dans les messages des commits

Voir la spécification GitHub

Commits Conventionnels 1.0.0

Résumé

La spécification de Commits Conventionnels est une convention basique pour des messages de commit propres. Elle fournit un ensemble simple de règles pour créer un historique de commit explicite, ce qui facilite l’écriture d’outils automatisés. Cette convention suit SemVer, en décrivant les fonctionnalités, les correctifs et les modifications importantes apportées aux messages de commit.

Le message du commit doit être structuré comme suit :

<type>[étendue optionnelle]: <description>

[corps optionnel]

[pied optionnel]

Le commit contient les éléments structurels suivants, permettant de communiquer à l’intention des consommateurs de votre API :

  1. fix: un commit de type fix corrige un bogue dans le code (cela est en corrélation avec PATCH en gestion sémantique de versions).
  2. feat: un commit de type feat introduit une nouvelle fonctionnalité dans le code (cela est en corrélation avec MINOR en gestion sémantique de versions).
  3. BREAKING CHANGE: un commit qui contient dans son pied le mot-clé BREAKING CHANGE:, ou dont le type/étendue est suffixé d’un !, introduit une rupture de compatibilité dans l’API (cela est en corrélation avec MAJOR en gestion sémantique de versions). Un BREAKING CHANGE peut faire partie des commits de n’importe quel type.
  4. Les types autre que fix: et feat: sont autorisés; par exemple, @commitlint/config-conventional (basé sur the Angular convention) recommande build:, chore:, ci:, docs:, style:, refactor:, perf:, test:, etc.
  5. Les pieds autres que BREAKING CHANGE: <description> peuvent être fournis et suivre une convention similaire à git trailer format.

Les types supplémentaires ne sont pas prescrits par la spécification de Commits Conventionnels et n’ont aucun effet implicite dans la gestion des versions sémantiques (à moins qu’ils ne comportent un BREAKING CHANGE). Une étendue peut être fournie au type d’un commit pour fournir des informations contextuelles supplémentaires. Elle est indiquée entre parenthèses, par exemple, feat(parser): add the ability to parse arrays.

Exemples

Message du commit avec description et breaking change dans le pied

feat: allow provided config object to extend other configs

BREAKING CHANGE: `extends` key in config file is now used for extending other config files

Message du commit avec ! qui attire l’attention sur un BREAKING CHANGE

feat!: send an email to the customer when a product is shipped

Message du commit avec étendue et ! qui attirer l’attention sur un BREAKING CHANGE

feat(api)!: send an email to the customer when a product is shipped

Message du commit avec ! et BREAKING CHANGE dans le pied

chore!: drop support for Node 6

BREAKING CHANGE: use JavaScript features not available in Node 6.

Message du commit sans corps

docs: correct spelling of CHANGELOG

Message du commit avec étendue

feat(lang): add polish language

Message du commit avec plusieurs paragraphes dans le corps, et plusieurs pieds

fix: prevent racing of requests

Introduce a request id and a reference to latest request. Dismiss
incoming responses other than from latest request.

Remove timeouts which were used to mitigate the racing issue but are
obsolete now.

Reviewed-by: Z
Refs: #123

Spécification

Les mots clés ”DOIT” (“MUST”), “NE DOIT PAS” (“MUST NOT”), “REQUIS” (“REQUIRED”), “DEVRA” (“SHALL”), “NE DEVRA PAS” (“SHALL NOT”), “DEVRAIT” (“SHOULD”), “NE DEVRAIT PAS” (“SHOULD NOT”), “RECOMMANDÉ” (“RECOMMENDED”), “PEUT” (“MAY”), et “FACULTATIF” (“OPTIONAL”) dans ce document doivent être interprétés comme décrit dans RFC 2119.

  1. Un commit DOIT être préfixé par un type, qui consiste en un nom (feat, fix, etc.), suivi par une étendue FACULTATIVE, un ! FACULTATIF, et de deux-points et d’un espace REQUIS.
  2. Le type feat DOIT être utilisé lorsqu’un commit ajoute une nouvelle fonctionnalité à votre application ou bibliothèque.
  3. Le type fix DOIT être utilisé lorsqu’un commit représente un correctif pour votre application.
  4. Une étendue PEUT être fournie après un type. Une étendue DOIT être un nom décrivant une section du code, et être encadrée par des parenthèses, par exemple, fix(parser):
  5. Une description DOIT suivre immédiatement les deux-points et l’espace après le préfixe type/étendue. La description est une brève description des modifications du code, par exemple, fix: array parsing issue when multiple spaces were contained in string.
  6. Un corps de commit PEUT être fourni après la description courte, fournissant des informations contextuelles supplémentaires sur les modifications du code. Le corps DOIT commencer par une ligne vide après la description.
  7. Un corps est libre et PEUT se composer d’un nombre quelconque de paragraphes séparés par une nouvelle ligne.
  8. Un ou plusieurs pieds PEUVENT être fournis avec une ligne blanche après le corps. Chaque pied DOIT se composer d’un mot-clé, suivi par :<space> ou <space>#, suivi d’une chaine de caractère (d’après git trailer convention).
  9. Un mot-clé de pied DOIT utiliser - au lieu des espaces, par exemple, Acked-by (cela permet de différencier la section de pied d’un corps de plusieurs paragraphes). Une exception est faite pour BREAKING CHANGE, qui PEUT aussi être utilisé comme un mot-clé.
  10. La valeur d’un pied PEUT contenir des espaces et des nouvelles lignes, et l’analyse grammaticale DOIT se terminer lorsqu’une nouvelle paire mot-clé / séparateur de pied valide est trouvée.
  11. Une rupture de compatibilité DOIT être indiquée soit dans le préfixe type/étendue d’un commit, soit comme une entrée dans le pied.
  12. Si elle est incluse comme pied, une rupture de compatibilité DOIT être écrite en majuscules : BREAKING CHANGE, suivi par deux-points, espace, et une description, par exemple, BREAKING CHANGE: environment variables now take precedence over config files.
  13. Si elle est incluse dans le préfixe type/étendue, une rupture de compatibilité DOIT être indiquée par un ! immédiatement avant le :. Si ! est utilisé, BREAKING CHANGE: PEUT être omis de la section de pied, et la description du commit DEVRA être utilisée pour décrire la rupture de compatibilité.
  14. Un type autre que feat et fix PEUT être utilisé, par exemple, docs: updated ref docs.
  15. Les unités d’information qui composent Commits Conventionnels NE DOIVENT PAS être traités comme sensibles à la casse par les développeurs, à l’exception de BREAKING CHANGE qui DOIT être en majuscules.
  16. BREAKING-CHANGE DOIT être synonyme de BREAKING CHANGE, lorsqu’il est utilisé comme mot-clé dans un pied.

Pourquoi utiliser Commits Conventionnels

FAQ

Comment dois-je gérer les messages de commit dans la phase de développement initiale ?

Nous vous recommandons de procéder comme si vous aviez déjà publié un produit. Généralement quelqu’un, même si ce sont vos collègues développeurs de logiciels, utilise votre logiciel. Ils voudront savoir ce qui est corrigé, ce qui casse, etc.

Les types dans le titre des commits sont-ils en majuscules ou en minuscules ?

N’importe quelle casse (majuscule ou minuscule) peut être utilisée, mais il est préférable d’être cohérent.

Que dois-je faire si le commit est conforme à plus d’un type de commit ?

Revenez en arrière et faites plusieurs commits autant que possible. Une partie des avantages de Commits Conventionnels réside dans sa capacité à nous inciter à créer des commits et des PR plus organisés.

Est-ce que cela ne décourage pas le développement rapide et l’itération rapide ?

Cela décourage les commits rapides et désorganisée. Il vous aide à être en mesure d’évoluer rapidement et à long terme dans plusieurs projets avec des contributeurs variés.

Les Commits Conventionnels pourraient-ils amener les développeurs à limiter le type d’engagement qu’ils effectuent car ils réfléchiront aux types fournis ?

Les Commits Conventionnels nous encouragent à utiliser davantage certains types de commits, tels que les correctifs. En dehors de cela, la flexibilité des Commits Conventionnels permet à votre équipe de créer ses propres types et de les modifier au fil du temps.

Quel est le lien avec SemVer ?

Les commits de type fix doivent être traduits en versions PATCH. Les commits de type feat doivent être traduits en versions MINOR. Les commits avec BREAKING CHANGE dans les commits, quel que soit leur type, doivent être traduits en versions MAJOR.

Comment dois-je mettre à jour mes extensions de la spécification de Commits Conventionnels, par exemple @jameswomack/conventionnel-commit-spec ?

Nous vous recommandons d’utiliser SemVer pour publier vos propres extensions à cette spécification (et vous encourageons à les créer !)

Que dois-je faire si j’utilise accidentellement le type de commit incorrect ?

Lorsque vous utilisez un type de commit incorrect, par exemple fix au lieu de feat

Avant de fusionner ou de publier l’erreur, nous vous recommandons d’utiliser git rebase -i pour éditer l’historique du commit. Après la publication, le nettoyage sera différent selon les outils et les processus que vous utilisez.

Lorsque vous utilisez un type qui n’est pas dans les spécifications, par exemple feet au lieu de feat

Dans le pire des cas, ce n’est pas la fin du monde si un commit atterrit sans respecter les spécifications de Commits Conventionnels. Cela signifie simplement que le commit sera ignoré par des outils basés sur les spécifications.

Est-ce que tous mes contributeurs doivent utiliser les spécifications de Commits Conventionnels ?

Non ! Si vous utilisez un flux de travail Git basé sur squash, les responsables principaux peuvent nettoyer les messages de validation au fur et à mesure de leur fusion, ce qui permet de ne pas ajouter de charge de travail aux contributeurs occasionnels. Un processus courant consiste à ce que votre système Git supprime automatiquement les validations d’une demande d’extraction et présente un formulaire permettant au responsable de la maintenance d’entrer le message de validation Git approprié pour la fusion.

Comment les Commits Conventionnels traitent-ils les annulations de commits ?

L’annulation de code peut être compliquée : est-ce une annulation de plusieurs commits ? Si vous annulez une fonctionnalité, la prochaine version devrait-elle être un correctif ?

Les Commits Conventionnels ne font pas d’effort explicite pour définir le comportement d’annulation. Au lieu de cela, nous laissons les auteurs d’outils utiliser la flexibilité des types et des pieds pour développer leur logique de traitement des annulations.

Une recommandation consiste à utiliser le type revert et un pied qui fait référence aux SHA de validation qui sont annulés:

revert: let us never again speak of the noodle incident

Refs: 676104e, a215868