-
Notifications
You must be signed in to change notification settings - Fork 9
CHANGELOG
Le changelog permet d'identifier facilement les changements apporter par une nouvelle version. Les règles édictées ici sont issues du standard Common Changelog.
## <version> - <date>
_Pour les changements détaillés et les discussions associées, consultez la pull request [#<Numéro de PR>](<URL de la PR>)_
La notice se limite à cette utilisation pour ce dépôt (Common Changelog permet d'autres utilisations que nous avons choisis de ne pas utiliser, cf #175)
On explicite les changements en 4 catégories différentes:
- Changed - pour les changements apportés à des fonctionnalités existantes.
- Added - Pour les ajouts de nouvelles fonctionnalités
- Removed - Pour le retrait de fonctionnalités
- Fixed - Pour la correction de problèmes
On présente les catégories avec un titre Markdown de 3ième niveau, et on liste les modifications. Exemple :
### Changed
- Met à jour les valeurs du SMIC avec les valeurs de 2023
- ...
- ...
Les modifications sont triées : D'abord les breaking changes puis par ordre d'importance.
Une version peut présenter plusieurs catégories de changements.
Ce sont les mêmes règles que celles des (Change groups de common-changelog)
Comme dans le changelog de la version 6.0.0
proposée ici, on peut voir le préfixe breaking qui va mettre en avant un changement particulier, ici changement qui entraine une incompatibilité avec les versions antérieures.
On peut utiliser les autre préfix common changelog