Messages de commit
La clarté des messages de commit facilite l'examen des demandes d'extraction et la génération des notes de version. Pour ce faire, le projet Blockly utilise des commits classiques.
Chaque commit doit avoir le format suivant:
<type>: <description>
[optional body]
[optional footer(s)]
Notez que le dépôt Blockly principal dispose d'un linter de commit pour faciliter ce processus. Si votre demande d'extraction comporte plusieurs commits, l'outil lint vérifie le titre. S'il ne comporte qu'un seul commit, il le vérifie. Il est préférable que vos commits individuels et le titre de la demande d'extraction respectent ces consignes.
Type
Le type doit être renseigné et tout en minuscules. Voici une liste des types acceptés.
- corvée
- Pour les commits qui effectuent des tâches de routine/automatisées telles que la mise à niveau des dépendances.
- abandonner
- Pour les commits qui rendent les fonctionnalités obsolètes
- feat
- Pour les commits qui ajoutent une nouvelle fonctionnalité à Blockly.
- fix
- Pour les commits qui corrigent des bugs/erreurs dans Blockly.
- release
- Pour les commits liés à la publication d'une nouvelle version.
Modifications destructives
Les commits qui apportent des modifications destructives doivent ajouter un ! après le type du commit. Les modifications destructives peuvent perturber les développeurs qui utilisent Blockly dans leurs applications, les obligeant à effectuer un travail supplémentaire.
Exemple :
fix!: return type of workspace.paste
Les modifications destructives peuvent être associées à l'un des types valides ci-dessus.
Description
La description doit être renseignée et ne doit pas dépasser 256 caractères.
Body
Le corps est facultatif. Si elle est fournie, une ligne vide doit figurer entre elle et la description. Il doit être composé de lignes de 256 caractères au maximum.
Notez qu'il est généralement conseillé de placer ce type d'informations dans la description de votre requête d'extraction, en plus du commit, plutôt que directement dans celui-ci.
Footer
Le pied de page est facultatif. Si tel est le cas, une ligne vide doit y figurer entre le texte et le corps. Il doit être divisé en lignes de 256 caractères maximum.
Corriger les commits non conventionnels
Si vous n'avez pas utilisé de commits classiques lorsque vous avez effectué vos modifications, il existe deux options pour corriger les messages en fonction du nombre de commits:
Si votre demande d'extraction comporte plusieurs commits, modifiez son titre pour qu'il respecte les exigences. Lors de la fusion de la demande d'extraction, vos autres commits sont écrasés afin que le titre devienne le message de commit.
Si votre requête d'extraction ne comporte qu'un seul commit, modifiez votre message de commit à l'aide de
git commit --amend, puis forcez le transfert de vos modifications vers votre copie de Blockly. Toutes les demandes d'extraction ouvertes associées à cette branche seront automatiquement mises à jour.git push --force origin my-branch.