Un bon message de commit facilite la compréhension des changements et améliore la collaboration. Voici 5 bonnes pratiques à adopter :
1- Décrire la finalité du changement
❌ Ajout d’un bouton
✅ feat(auth): Ajouter un bouton pour permettre aux utilisateurs de réinitialiser leur mot de passe
2- Se concentrer sur l’objectif du commit, pas sur l’implémentation
❌ Modification du style des liens dans le CSS
✅ style(ui): Améliorer la lisibilité des liens dans le thème sombre
3- Utiliser l’impératif et le présent
❌ J’ai corrigé un problème d’affichage
✅ fix(mobile): Corriger un problème d’affichage sur les petits écrans
4- Référencer la tâche ou le ticket associé
❌ Correction d’un bug sur la pagination
✅ hotfix(orders): #127 Corriger le problème de pagination sur la liste des commandes
5- Éviter de mentionner les fichiers concernés
❌ Mise à jour du fichier config.yml
✅ chore(config): Ajuster la configuration pour activer la compression des fichiers
Ces conventions sont définies par Conventional Commits, une norme qui améliore la lisibilité et l’automatisation des versions logicielles. Pour aller plus loin, le lien de la documentation officielle: https://lnkd.in/eP2U6sSU
🙌