Muutoslokiin

Muutoslokiin, eli changelogiin, on projektin ohjelmiston kohdistuvien muutosten kronologinen rekisteri. Se kattaa julkistetut versiot ja niihin liittyvät parannukset, korjaukset sekä mahdolliset breaking changes. Muutosloki auttaa sekä käyttäjiä että kehitystiimiä näkemään, mitä on muuttunut ja miksi.

Tarkoitus on viestiä selkeästi, mitkä uudet ominaisuudet on lisätty, mitä on muutettu, mitkä ongelmat on korjattu ja onko jollain versiolla ollut vaikutuksia yhteensopivuuteen. Hyvin ylläpidetty muutosloki tukee päivitysten hallintaa, virheiden jäljittämistä sekä sovelluksen dokumentaatiota ja auditointia.

Rakenne vaihtelee projektin mukaan, mutta tavallisesti muutosloki sisältää versionumeron, julkaisupäivämäärän ja erilliset osiot kuten Uudet ominaisuudet (Added), Muutokset (Changed), Korjaukset (Fixed), Poistetut (Removed) sekä Turvallisuus (Security). Osioihin voidaan viitata yksittäisiin tiket- numeroihin ja lyhyisiin kuvauksiin.

Hyvä käytäntö on laatia muutosloki järjestelmällisesti, mielellään automaation avulla commit-viesteistä tai versionhallinnan työkalujen kautta. Monet projektit seuraavat Keep a Changelog -periaatteita tai Conventional Commits -standardia, ja käyttävät semanttista versioningia (SemVer). Tämä tekee muutoksista ennustettavampia ja helpottaa kolmansien osapuolten integraatioita.