Qu’est-ce qu’un changelog ?
Un changelog (journal des modifications) est un fichier qui contient une liste triée antéchronologiquement des changements notables pour chaque version d’un projet.
Pourquoi tenir un changelog ?
Pour permettre aux utilisateurs et contributeurs de voir précisément quels changements notables ont été faits entre chaque publication (ou version) d’un projet.
Plus de détails sur https://keepachangelog.com.
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 chaque version, indiquer le numéro de version suivi de la date au format ANNÉE-MOIS-JOUR.
Les entrées sont regroupés par catégorie. Voici les catégories utilisées dans SPIP.
| Type d’entrée | Signification |
|---|---|
| Added | Pour les nouvelles fonctionnalités |
| Changed | Pour les changements aux fonctionnalités préexistantes |
| Deprecated | Pour les fonctionnalités qui seront bientôt supprimées |
| Removed | Pour les fonctionnalités désormais supprimées |
| Fixed | Pour les corrections de bugs |
| Security | En cas de vulnérabilités |
Exemple de Changelog simple
# Changelog
## 1.0.2 - 2023-07-25
## Fixed
- Ne pas afficher le texte du modèle `icone` et le mettre en `title` du lien
### Changed
- mise à jour du README.md maintenant que la doc est sur contrib
## 1.0.1 - 2023-06-22
### Added
- ajout d'un CHANGELOG.md
### Changed
- compatibilité SPIP 4.1+
- mise à jour de la documentation dans le README.md
Exemple de changelog complet
Pour un exemple plus complet, voir celui de SPIP.