Qu'est-ce qu'un générateur de messages de validation Git ?
Un générateur de messages de validation Git aide les développeurs à créer des messages de validation bien structurés conformément à la spécification Conventional Commits. Les validations conventionnelles fournissent un format standardisé - type(scope): description - qui rend l'historique des validations lisible, permet la gestion automatisée des versions avec des outils tels que la publication sémantique et simplifie la génération du journal des modifications. Cet outil vous guide à travers chaque partie du message de validation pour garantir la cohérence de votre projet.
Comment utiliser le générateur de messages Git Commit
- 1Sélectionnez le type de commit (feat, fix, docs, style, refactor, perf, test, build, ci, corvée ou revert) dans la liste déroulante.
- 2Entrez éventuellement une portée pour indiquer la zone de la base de code affectée (e.g., auth, api, ui).
- 3Rédigez une brève description concise du changement d’humeur impérative.
- 4Ajoutez éventuellement un corps plus long pour fournir un contexte supplémentaire sur le changement.
- 5Activez 'Breaking Change' si le commit introduit un changement d'API avec rupture et décrivez ce qui casse.
- 6Ajoutez éventuellement des références de pied de page telles que 'Closes #123' ou 'Refs #456'.
- 7Activez 'Include emoji prefix' pour ajouter un emoji visuel au type de validation.
- 8Copiez le message de validation généré à l'aide du bouton Copier.
Cas d'utilisation
Automatisation du versioning sémantique
Utilisez les validations conventionnelles pour permettre à des outils tels que la version sémantique ou la version standard de déterminer automatiquement les modifications de version (majeures, mineures, correctifs) en fonction des types de validation.
Génération automatisée du journal des modifications
Générez automatiquement des journaux de modifications structurés à partir de l'historique des validations, en regroupant les fonctionnalités, les corrections de bugs et les modifications de rupture dans des notes de version organisées.
Normes d'engagement de l'équipe
Appliquez un formatage cohérent des messages de validation au sein des équipes de développement, ce qui facilite la navigation et la compréhension de la révision du code et de l'historique du projet.
Contributions open source
Suivez les conventions de validation largement adoptées lorsque vous contribuez à des projets open source qui nécessitent des validations conventionnelles pour leurs pipelines CI/CD.
Questions fréquentes
Qu'est-ce que le format des commits conventionnels ?
Conventional Commits est une spécification permettant d'écrire des messages de validation standardisés. Le format est le suivant : type(scope) : description, éventuellement suivie d'un corps et d'un pied de page. Des types comme 'feat' et 'fix' correspondent respectivement aux bosses de version sémantique MINOR et PATCH, tandis qu'un pied de page 'BREAKING CHANGE' ou '!' après le type déclenche une bosse MAJEURe.
Quel type de commit dois-je utiliser ?
Utilisez 'feat' pour les nouvelles fonctionnalités, 'fix' pour les corrections de bogues, 'docs' pour les modifications de la documentation, 'style' pour les modifications de formatage, 'refactor' pour la restructuration du code, 'perf' pour l'amélioration des performances, 'test' pour les modifications de test, 'build' pour les modifications du système de build, 'ci' pour les modifications de configuration CI, 'chore' pour les tâches de maintenance et 'revert' pour revenir aux versions précédentes. s'engage.
La portée est-elle requise ?
Non, la portée est facultative. Il fournit un contexte supplémentaire sur la partie de la base de code affectée (e.g., 'auth', 'api', 'ui'). Certaines équipes exigent des étendues tandis que d'autres les laissent facultatives : suivez les conventions de votre projet.
Que signifie le '!' avant les deux points ?
Un point d'exclamation '!' placé après le type/portée et avant les deux points indique un changement radical. Par exemple, 'feat(api)!: change auth endpoint' signale que ce commit introduit un changement radical de l'API, équivalent à l'ajout d'un pied de page 'BREAKING CHANGE'.
Puis-je utiliser des emojis dans les messages de validation ?
Oui, de nombreuses équipes et projets open source utilisent des emojis comme préfixes visuels pour les types de commit (e.g., ✨ pour feat, 🐛 pour fix). Bien qu'ils ne fassent pas partie de la spécification officielle des commits conventionnels, les emojis peuvent améliorer la lisibilité dans les journaux de validation et les interfaces GitHub. Activez l'option emoji dans cet outil pour les inclure.