Commencer
Découvrez notre convention de commit
Nous aimons avoir un historique de projet propre. Notre convention de commits est inspirée par Conventional Commits mais personnalisée avec gitmoji pour rendre ça plus visuel et amusant.
Structure
Le message de commit doit être structuré comme suit et en minuscules :
<gitmoji> <type> <description> [(#<numéro de l'issue>)]
[corps optionnel]
[pied(s) de page optionnel(s)]
Exemple
📝 mise à jour des contributeurs de la documentation
- Ajouter @jerembdn en tant que contributeur
- Ajouter @younesbessa en tant que contributeur
Co-authored-by: Younes Bessa <[email protected]>
La plupart du temps, une simple ligne suffit :
📝 mise à jour des contributeurs de la documentation
Types
Nous utilisons les types de commit suivants :
| Type | Description |
|---|---|
add | Ajouter une nouvelle fonctionnalité |
fix | Corriger un bug |
improve | Améliorer quelque chose |
update | Mettre à jour quelque chose |
remove | Supprimer quelque chose |
refactor | Refactoriser quelque chose |
rename | Renommer quelque chose |
move | Déplacer un fichier ou un dossier |
upgrade | Mettre à jour les dépendances |
downgrade | Rétrograder les dépendances |
initial | Commit initial d’un dépôt |
release | Release / tag de version |
Le premier commit d’un dépôt utilise initial, et un tag de version utilise release :
🎉 commit initial
🔖 release @onruntime/translations v0.3.0
Description
Le <type> est le verbe du sujet, et la description le complète. Lue ensemble, ils forment une phrase :
# Bon
📝 mise à jour des contributeurs de la documentation
Donc, n'ouvrez pas la description avec un second verbe. Le type est déjà un, et le sujet finit par empiler deux phrases, ce qui est ce que le préfixe fix: entraîne. Laissez tomber le verbe et gardez ce sur quoi il a agi :
# Mauvais
💄 améliorer la réduction du gem sur sa carte
🐛 corriger l’arrêt du pied de page pour qu'il ne se plie pas
# Bon
💄 améliorer la taille du gem sur sa carte
🐛 corriger le pliage du pied de page
Écrivez-le à la forme impérative et en minuscules :
# Mauvais
📝 mis à jour des contributeurs de la documentation
# Mauvais
📝 Mise à jour des contributeurs de la documentation
Un Verbe Qui Est un Nom
Certains mots sont les deux, et celui que vous voulez dire est le nom : ✨ ajouter une image open graph convient. Quand cela se lit comme un verbe, un article en fait un groupe nominal : ✨ ajouter un bouton afficher plus.
Numéro d'Issue
Liez les commits aux issues en ajoutant le numéro de l'issue :
📝 mise à jour des contributeurs de la documentation (#123)
Corps
Utilisez le corps pour le contexte et la motivation :
📝 mise à jour des contributeurs de la documentation
- Ajouter @jerembdn en tant que contributeur
- Ajouter @younesbessa en tant que contributeur
Co-authored-by: Younes Bessa <[email protected]>
Un Commit, Un Objectif
Chaque commit doit représenter un changement logique unique. Ne mélangez pas des changements sans rapport.