Changelog: wat is het en hoe werkt het?

Een changelog is een document waarin wijzigingen worden bijgehouden. In software zijn wijzigingen en verbeteringen de praktijk van alle dag. Er worden nieuwe features toegevoegd, bugs worden gefixt of er worden beveiligingupdates doorgevoerd.

In deze blog vertellen we je welke informatie er nog meer in een changelog staat, voor wie het bedoeld is waarom je het kan gebruiken. Voor de techneuten hebben we een checklist toegevoegd om je eigen changelog te schrijven.

Wat staat er in een changelog?

In een changelog houd je de volgende informatie bij:

• Added voor nieuwe features.
• Changed voor veranderingen in bestaande features.
• Deprecated voor features die binnenkort gaan vervallen.
• Removed voor features die zijn vervallen en zijn verwijderd.
• Fixed voor bugfixes.
• Security als er kwetsbaarheden zijn aangepakt op het gebied van veiligheid.

Per update verandert het versienummer en wordt er een log gemaakt. Hierin wordt minimaal een van de bovenstaande onderwerpen beschreven. De logs worden altijd chronologisch gesorteerd zodat duidelijk is wat er per update is veranderd; je kunt het hele verhaal van de applicatie doorlezen.

Voor wie zijn changelogs bedoeld?

Een changelog is bedoeld voor de mensen die te maken hebben met de software. Dit zijn naast developers dus ook de mensen die werken met de software.

Waarom changelog gebruiken?

Om naar de klant, gebruikers en developers te communiceren welke wijzigingen zijn aangebracht in elke versie van het product.

Checklist voor een goede changelog:

• Logs spreken de taal van mensen, geen vakjargon.
• Voor elke versie is een log opgenomen.
• Logs zijn chronologisch gesorteerd en de laatste versie staat bovenaan.
• Bij elke versie staat een release datum.
• Logs zijn compact beschreven, wijzigingen die bij elkaar horen zijn gegroepeerd.
• Logs bevatten beginnen allemaal met added, changed, deprecated, removed, fixed of security.
• Als je een digitale changelog gebruikt: zorg voor een klikbare inhoudsopgave.
• Geef aan als je Semantic Versioning gebruikt.