Conventional Commits pour VS Code

Conventional Commits est une spécification pour l'écriture de messages de livraison git standardisée. Cet article explique comment utiliser les Conventional Commits de manière pratique dans Visual Studio Code.

À propos de Conventional Commits

Conventional Commits est une spécification ouverte et gratuite hébergée sur GitHub qui décrit comment écrire un message de validation standardisé.

Il existe un certain nombre de types de changements, par exemple un correctif, une fonctionnalité ou un test. Ensuite, vous pouvez spécifier une portée facultative. Après cela, vous décrivez vos changements. S'il s'agit de changements de rupture, vous écrivez en lettres majuscules "BREAKING CHANGE" ou un point d'exclamation (!) après le type.

Voici un exemple de message :

fix(UI Widget): correction de fautes de frappe mineures dans le code

voir le numéro PROJ-34 pour plus d'informations

Pourquoi utiliser Conventional Commits

Le site web de Conventional Commits indique ces cinq raisons pour utiliser Conventional Commits :

• Générer automatiquement des CHANGELOGs.
• Déterminer automatiquement un saut de version sémantique (basé sur les types de commits déposés).
• Communiquer la nature des changements aux coéquipiers, au public et aux autres parties prenantes.
• Déclencher les processus de construction et de publication.
• Faciliter la contribution des personnes à vos projets, en leur permettant d'explorer un historique de commit plus structuré.

Conventional Commits dans VS Code

Penser toujours à la bonne structure pour le message commit peut être un peu difficile. C'est pourquoi il existe une extension pour Visual Studio Code qui facilite la vie des auteurs de messages de type messages de commit conventionnels.

Cette extension est judicieusement nommée Conventional Commits for VSCode.

Elle offre un certain nombre de fonctionnalités intéressantes, notamment la saisie de la portée et un message détaillé. De plus, vous pouvez inclure des gitmojis qui sont très utiles.

L'extension est facilement accessible dans la vue du contrôle de la source, juste à côté du bouton "commit". Lorsque vous cliquez sur le bouton de Conventional Commits vous verrez apparaître une boîte de dialogue d'assistant dans laquelle vous pourrez choisir simplement parmi un certain nombre d'options.

La première partie est le type de changement que vous voulez commettre (comme un correctif, une fonctionnalité ou une documentation parmi d'autres possibilités). Ensuite, vous pouvez saisir une portée facultative du changement. Enfin, vous pouvez choisir un gitmoji visuel.

L'étape suivante est importante, car vous devez taper une description courte et tendue de la modification. Après cela, vous pouvez optionnellement taper une description plus longue et ensuite lister les changements de rupture si vous en avez.

À la fin de l'assistant, vous pouvez voir votre message composé dans le champ de texte git commit message text field. Si vous le souhaitez, vous pouvez corriger les erreurs que vous avez pu faire, puis valider la modification dans le contrôle de la source.

Conclusion

Les Conventional Commits sont un bon moyen de standardiser les messages de commit au sein de votre équipe pour faciliter le traitement des messages git. L'extension Visual Studio Code Conventional Commits permet au développeur d'écrire des messages dans ce format. Elle vaut la peine d'être consultée.

Références

• Conventional Commits Spec: https://www.conventionalcommits.org

• Extension Conventional Commits pour VS Code: https://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commits

• Gitmojis: https://gitmoji.dev