Voici ma proposition d’ajout à Contribuer au développement de SPIP - SPIP
Au point 3 de la liste :
Les messages des commits de la branche issue_xxx doivent suivre la nomenclature des Commits Conventionnels. Le corps du message doit être clair et explicatif : décrire le problème traité et les évolutions ou corrections apportées. De plus, il faut bien veiller à ajouter une ligne dans la fichier CHANGELOG du dépôt dans un commit à part afin d’éviter les conflits lors de la fusion. Pour finir, la série de commits doit être linéaire (sans commits de merge).
Puis, à la fin de ce bloc « Règles de contribution » :
À propos des Commits Conventionnels et des fichiers CHANGELOG
La liste des types disponibles pour les commits conventionnels est la suivante : build, change, chore, ci, deprecate, doc, feat, fix, perf, remove, revert, security, style, test, i18n
(détails sur git.spip.net). Le pied de page du message doit contenir une référence au ticket lié à la PR sous la forme Fix: #XXX
. Exemple de log de commit complet :
fix: réparer le lien vers la licence GPL dans le pied des pages du privé
en le remplaçant par un simple lien vers le site officiel gnu.org
Fix: #5328
Les fichiers de CHANGELOG suivent la norme Tenez un Changelog. Chaque entrée du changelog doit :
- référencer le ticket (ou la PR s’il n’y a pas de ticket correspondant)
- décrire clairement et de manière concise les modifications apportées par la PR (pour cela, vous pouvez simplement reprendre la première ligne du message de commit)
Exemple d’entrée de changelog correspondante au log de commit précédent :
- #5328 Réparer le lien vers la licence GPL dans le pied des pages du privé
Dites moi si ça vous va ou si c’est plus pratique que je colle ça direct dans l’article pour faciliter la relecture.