What is a changelog?
A changelog (change log) is a file that contains a chronological list of notable changes for each version of a project.
Why keep a changelog?
To allow users and contributors to see exactly what notable changes have been made between each release (or version) of a project.
More details at https://keepachangelog.com.
Each entry in the changelog must:
- reference the ticket (or the PR if there is no corresponding ticket);
- clearly and concisely describe the changes made by the PR;
For each version, indicate the version number followed by the date in YEAR-MONTH-DAY format.
Entries are grouped by category. Here are the categories used in SPIP.
| Entry type | Meaning |
|---|---|
| Added | For new features |
| Changed | For changes to existing features |
| Deprecated | For features that will soon be removed |
| Removed | For features that have now been removed |
| Fixed | For bug fixes |
| Security | In case of vulnerabilities |
Example of simple changelog
# 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
Example of complete changelog
For a more comprehensive example, see SPIP.