diff --git a/README.md b/README.md index 541d58c..a39bed1 100644 --- a/README.md +++ b/README.md @@ -227,7 +227,6 @@ En cas de doute, si vous pensez avoir fait une erreur, vous pouvez annuler toute git rebase --abort - ### Le merge request ### Les commits @@ -248,20 +247,20 @@ Structure d’un message de commit : ##### Les _types_ Les types de commits possibles sont les suivants (par ordre alphabétique): -- **ci** : concerne le fonctionnement de la CI du dépôt. -- **docs** : reprise de la documentation du code sans toucher aux fonctionnalités. -- **feat** : ajoute une fonctionnalité qui doit être mentionnée dans le pied de page avec un hashtag et son numéro de ticket (entraîne un changement de type _mineur_ dans le versionnement). -- **fix** : résoud un bug qui doit être mentionné dans le pied de page avec un hashtag et son numéro de ticket (entraîne un changement de type _patch_ dans le versionnement). -- **refactor** : refactorisation du code sans modifier son comportement, ajouter une fonctionnalité ou réparer un bug. -- **removed** : effacement d’une partie jugée inutile, redondante ou obsolète -- **security** : gestion d’une vulnérabilité -- **style** : reprise formelle du code sans en modifier le fonctionnement (typos, espacements, tabulations etc.) +- **ci** : concerne le fonctionnement de la CI du dépôt (entraîne un changement de type _bugfix_ dans le versionnement). +- **docs** : reprise de la documentation du code sans toucher aux fonctionnalités (entraîne un changement de type _bugfix_ dans le versionnement). +- **feat** : ajoute une fonctionnalité qui doit être mentionnée dans le pied de page avec un hashtag et son numéro de ticket (entraîne un changement de type _minor_ dans le versionnement). +- **fix** : résoud un bug qui doit être mentionné dans le pied de page avec un hashtag et son numéro de ticket (entraîne un changement de type _bugfix_ dans le versionnement). +- **refactor** : refactorisation du code sans modifier son comportement, ajouter une fonctionnalité ou réparer un bug (entraîne un changement de type _bugfix_ dans le versionnement). +- **removed** : effacement d’une partie jugée inutile, redondante ou obsolète (entraîne un changement de type _minor_ ou _major_, selon le cas, dans le versionnement). +- **security** : gestion d’une vulnérabilité (entraîne un changement de type _minor_ ou _major_, selon le cas dans le versionnement). +- **style** : reprise formelle du code sans en modifier le fonctionnement (typos, espacements, tabulations etc.) (entraîne un changement de type _bugfix_ dans le versionnement). -Le cas échéant, il est possible d’ajouter de nouveaux types selon les besoins (se référer à [la convention Angular](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type) par exemple). +Le cas échéant, il est possible d’ajouter de nouveaux types selon les besoins (se référer à [la convention Angular](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type) ou [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) par exemple). Il faut alors penser à modifier les scripts de génération de changelog en conséquence (ainsi que les conséquences sur les séquences de versionnement). Le type doit être écrit en minuscule, sans espace. -##### La portée +##### La portée (facultatif) Indiquée entre parenthèses, en minuscule sans espace, elle permet de préciser éventuellement sur quel partie du code la modification porte. Elle peut être choisie dans cette liste :