Release notes

Publiceer documentatie over de wijzigingen in softwarereleases in een CHANGELOG.md bestand, zodat gebruikers weten wat ze kunnen verwachten en hoe ze kunnen migreren naar de nieuwe versie.

Volg de CHANGELOG.md filename-conventie, zodat de release notes op diverse manieren gebruiksvriendelijk beschikbaar worden gemaakt, bijvoorbeeld met in Pull Requests van Dependabot, of in de GitHub user interface.

Automatiseer de release notes

Voorkom dat iedereen de CHANGELOG.md file direct moet wijzigen via Git, en daardoor steeds weer merge conflicts ontstaan. De release notes bijhouden moet niet een tijdrovend en frustrerend proces zijn.

Gebruik de changesets workflow voor het vastleggen van wijzigingen in .changeset/*.md-bestanden.

Gebruik de changeset tool in de CI/CD pipeline om de CHANGELOG.md bestanden aan te vullen.