Guide des messages de commit

Messages de commit

Des messages de commit clairs facilitent l'examen des demandes d'extraction et la génération des notes de version. Le projet Blockly utilise des commits conventionnels pour faciliter cette tâche.

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 vous aider à appliquer cette règle. Si votre demande d'extraction comporte plusieurs commits, le linter vérifiera le titre. S'il ne comporte qu'un seul commit, il le vérifiera. Il est préférable que vos commits individuels et le titre de la demande d'extraction suivent ces consignes.

Type

Le type ne doit pas être vide et doit être en minuscules. Voici la liste des types acceptés.

  • chore : pour les commits qui effectuent des tâches de routine/automatisées telles que la mise à niveau des dépendances.

  • deprecate : pour les commits qui rendent une fonctionnalité obsolète.

  • feat : pour les commits qui ajoutent de nouvelles fonctionnalités à 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 importantes

Les commits qui apportent des modifications incompatibles doivent ajouter un ! après le type de commit. Les modifications majeures sont des modifications qui peuvent perturber les développeurs utilisant Blockly dans leurs applications, ce qui les oblige à effectuer un travail supplémentaire.

Par exemple : none fix!: return type of workspace.paste

Les modifications incompatibles peuvent être de l'un des types valides ci-dessus.

Description

La description ne doit pas être vide et doit comporter moins de 256 caractères.

Body

Le corps est facultatif. Si elle est fournie, une ligne vide doit la séparer de la description. Il doit être divisé en lignes de 256 caractères maximum.

Notez qu'il est généralement conseillé de placer ce type d'informations dans la description de votre demande d'extraction, en plus ou à la place de les mettre directement dans le commit.

Le pied de page est facultatif. Si elle est fournie, une ligne vide doit la séparer du 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 conventionnels lorsque vous avez apporté vos modifications, deux options s'offrent à vous pour corriger les messages, en fonction du nombre de commits que vous avez :

  1. Si votre demande d'extraction comporte plusieurs commits, modifiez son titre pour qu'il respecte les exigences. Lorsque la demande d'extraction est fusionnée, vos autres commits sont compressés de sorte que le titre devienne le message de commit.

  2. Si votre demande d'extraction ne comporte qu'un seul commit, modifiez le message de commit à l'aide de git commit --amend, puis forcez l'envoi de vos modifications vers votre fork de Blockly. Toutes les demandes d'extraction ouvertes associées à cette branche seront automatiquement mises à jour. git push --force origin my-branch.