Améliorez vos commits en < 30sec avec Commitizen

Vous en avez marre de voir ça ?

‍

Utiliser Commitizen pour améliorer vos messages de commit dans un projet TypeScript

La gestion de versions et la clarté des messages de commit sont des aspects cruciaux dans le cycle de vie d'un projet de développement. Commitizen est un outil qui aide à standardiser et à rendre les messages de commit plus lisibles. Dans cet article, nous allons voir comment intégrer Commitizen dans un projet TypeScript.

Pourquoi Commitizen?

Commitizen est un outil qui facilite la rédaction de messages de commit standardisés. Il s'intègre bien avec les conventions de commit comme Conventional Commits, qui aident à rendre les historiques de commit plus compréhensibles et à faciliter la génération automatique des versions et des changelogs.

Installation de Commitizen 👇🏻

npm install git-cz --save-de
ou
yarn add git-cz --dev

‍

Utiliser Commitizen pour faire des commits 👇🏻

Vous avez juste à faire

 npx git-cz
 ou
 yarn git-cz

Vous devriez voir ça dans votre terminal

Vous n'avez plus qu'à vous laisser guider par les prompt.

Votre arbre git finira par ressembler à ceci

Ça a quand même plus de gueule non ?

‍

Avantages de l'utilisation de Commitizen

1. Standardisation: Garantir que tous les messages de commit suivent le même format.
2. Lisibilité: Améliorer la compréhension de l'historique des commits.
3. Automatisation: Faciliter la génération automatique des changelogs et des numéros de version.
4. Communication: Améliorer la communication au sein de l'équipe de développement.

En adoptant Commitizen, vous améliorez non seulement la clarté de vos commits, mais vous facilitez également la collaboration et la maintenance de votre projet.

Aller plus loin

Pour forcer l'utilisation de commitizen pour tous les contributeurs, je vous conseille d'utiliser les hooks husky.

Voir mon article à ce sujet ici 👉🏻 https://www.phdr.dev/blog/blinder-son-code-avec-husky

Une fois husky mis en place, il vous suffit d'ajouter le fichier ./husky/prepare-commit-msg et d'y écrire :

yarn git-cz
#ou
npm run git-cz

‍Ainsi, dès que vous lancerez la commande git commit, git cz se lancera automatiquement.

‍

‍