Een changelog is een bestand met een samengestelde, chronologisch geordende lijst met opmerkelijke wijzigingen voor elke versie van een project. In dit geval gaat hem om de wijzigingen van de componenten. Het wordt gebruikt om het voor collega’s en anderen inzichtelijk te maken welke wijzigingen zijn aangebracht tussen elke release of versie. De wijzigingen zijn onder ieder component te vinden.
Leidende principes
- Changelogs zijn bedoeld voor mensen, geen machines
- Elke versie moet een vermelding bevatten
- Dezelfde soort wijzigingen moeten worden gegroepeerd
- Versies en secties moeten koppelbaar zijn
- De nieuwste versie staat bovenaan
- De releasedatum van elke versie wordt weergegeven
Type wijzigingen
- Toegevoegd voor nieuwe functies
- Gewijzigd voor wijzigingen in bestaande functionaliteit
- Vervallen voor binnenkort te verwijderen functies
- Verwijderd voor nu verwijderde functies
- Opgelost voor eventuele bugfixes
- Beveiliging in geval van kwetsbaarheden