Update rule of commit

[pplancq]

Règles de Commit

Convention de Commit

Nous utilisons Conventional Commits pour nous assurer que les messages de commit respectent les conventions spécifiées.

<type>[scope]: <description>

[optional body]

[optional footer(s)]

Voici les règles à suivre pour les scopes de commit :

• Utilisez le scope correspondant au design system mis à jour par le commit. Les scopes disponibles sont :
  • slash
  • look&feel
  • apollo
• Si le commit traite de deux ou plusieurs design systems, séparez les scopes par une virgule (,).
• Si le commit est plus général au projet, utilisez le scope design-system.
• Les scopes deps, deps-dev et release sont réservés et ne doivent pas être utilisés.

Exemples de messages de commit valides :

feat(slash): ajout d'un nouveau composant
fix(look&feel,apollo): correction des styles et des icônes
chore(design-system): mise à jour des dépendances

Breaking Changes

Pour indiquer un changement majeur qui casse la compatibilité, ajoutez un '!' entre le scope et les ':' ainsi qu'une section "BREAKING CHANGE" dans le footer du commit.

Le '!' permet de signaler que le commit contient une breaking change.
La section "BREAKING CHANGE" permet de décrire les changements majeurs apportés par le commit.

Exemple :

feat(slash)!: suppression des classModifiers

BREAKING CHANGE: Les classModifiers ont été supprimés des composant Slash. Il faut désormais utiliser les props dédiés comme `variant` ou `size`.

[pplancq]

On peut voir que la CI fait bien son office et analyse bien l'ensemble des commit de la PR

[sonarqubecloud]

Quality Gate failed

Failed conditions
60.0% Coverage on New Code (required ≥ 80%)
7.5% Duplication on New Code (required ≤ 3%)
C Reliability Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

[johnmeunier]

Peut-on ajouter un scope qui n'est pas dans la liste ? Par exemple "slash,pricing" ?

[pplancq]

Peut-on ajouter un scope qui n'est pas dans la liste ? Par exemple "slash,pricing" ?

Alors d'après mes tests sur la configuration actuel proposer par cette PR:
le scope n'est pas obligatoire: donc "feat: commit" est valide (ce qu'il me faut corriger car on veux qu'il soit obligatoire)

par contre les scopes possible sont uniquement ce de la liste, donc est ce que cela convient ou préférez vous avoir au moins un scope de la liste plus un au choix (facultatif) en fonction du contexte, exemple "fix(slash,button): fix some bug on button"

[sonarqubecloud]

Quality Gate failed

Failed conditions
48.3% Coverage on New Code (required ≥ 80%)
6.9% Duplication on New Code (required ≤ 3%)
C Reliability Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

[pplancq]

Mis à jours des règles scope obligatoire, et uniquement ceux fixé par la liste.

[johnmeunier]

Peut-on ajouter un scope qui n'est pas dans la liste ? Par exemple "slash,pricing" ?

Alors d'après mes tests sur la configuration actuel proposer par cette PR: le scope n'est pas obligatoire: donc "feat: commit" est valide (ce qu'il me faut corriger car on veux qu'il soit obligatoire)

par contre les scopes possible sont uniquement ce de la liste, donc est ce que cela convient ou préférez vous avoir au moins un scope de la liste plus un au choix (facultatif) en fonction du contexte, exemple "fix(slash,button): fix some bug on button"

Je pense qu'effectivement c'est mieux si le deuxième peut ne pas être dans la liste