From 8266c1765492f229f1ca0f15f67d9fdc46bd3a67 Mon Sep 17 00:00:00 2001 From: XavDmz <30922860+XavDmz@users.noreply.github.com> Date: Thu, 11 May 2023 16:44:18 +0200 Subject: [PATCH 1/2] Update CONTRIBUTING.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Ajout d'une consigne dédiée au changelog. --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 02aa3bf..c7542bb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,3 +9,13 @@ Il s'agit principalement de lignes directrices, et non de règles. Faites preuve Nous utilisons les git hooks via [pre-commit](https://pre-commit.com/) pour appliquer et vérifier automatiquement certaines "règles". Veuillez l'installer avant de pousser un commit. Voir le fichier de configuration correspondant : `.pre-commit-config.yaml`. + +## CHANGELOG + +Pour éviter les conflits d'édition du changelog en cas de multiples contributions parallèles, n'éditez pas directement le fichier `CHANGELOG.md` sur votre branche de travail. +A la place, indiquez en description ou commentaire de votre pull request, bien en évidence, le changelog qui concerne spécifiquement cette PR, avec le même formalisme que le fichier `CHANGELOG.md`. +Le mainteneur qui validera la PR éditera alors ce fichier dans le même temps, avec deux objectifs : + +* la date de modification sera celle de la fusion de branches. +* le contenu pourra tenir compte de toutes les modifications depuis la dernière release. + From 5cf0aa6488bf7358f6c89c997e81102024b9eb90 Mon Sep 17 00:00:00 2001 From: XavDmz <30922860+XavDmz@users.noreply.github.com> Date: Thu, 11 May 2023 16:53:33 +0200 Subject: [PATCH 2/2] Update CONTRIBUTING.md Ajout d'une description du formalisme attendu pour le changelog. --- CONTRIBUTING.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c7542bb..caa2d20 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,3 +19,32 @@ Le mainteneur qui validera la PR éditera alors ce fichier dans le même temps, * la date de modification sera celle de la fusion de branches. * le contenu pourra tenir compte de toutes les modifications depuis la dernière release. +Le formalisme du changelog est le suivant, en markdown : + +```md +### [Added] + +Liste de nouvelles fonctionnalités. + +### [Changed] + +Liste de fonctionnalités existantes modifiées. + +### [Deprecated] + +Liste de fonctionnalités dépréciées. + +### [Removed] + +Liste de foncitonnalités retirées. + +### [Fixed] + +Liste de corrections fonctionnelles. + +### [Security] + +Liste de corrections de sécurité. +``` + +Les parties vides, sans élément à lister, peuvent être ignorées.