ændringslog

Et ændringslog, også kaldet en changelog, er en oversigt over væsentlige ændringer i et softwareprodukt, et projekt eller en tjeneste mellem versioner. Det dokumenterer hvad der er tilføjet, ændret, rettet eller fjernet siden sidste udgivelse og kan også omtale baggrunde eller kendte problemer.

Formålet med et ændringslog er at informere brugere, kunder og udviklere om, hvad der er ændret, hvorfor ændringen er foretaget, og hvordan den påvirker brugen eller integrationen. Det understøtter også sporbarhed og releaseplanlægning og gør det lettere at undersøge historiske ændringer.

En typisk struktur viser versionsnummer og udgivelsesdato, efterfulgt af en beskrivelse af ændringer. Mange projekter inddeler ændringerne i kategorier som Tilføjet (nye funktioner), Ændret (ændringer i eksisterende funktioner), Rettet (fejlrettelser), Sikkerhed (sikkerhedsrettelser) og Fjernet (udgåede funktioner). Nogle anvender også et kort opsummerende afsnit og referencer til sager i issue-tracker.

Versionering kan følge semantisk versionering (major.minor.patch) eller andre konventioner, og nogle projekter inkluderer et "Unreleased" afsnit før hver udgivelse. Ændringsloggen bør holdes opdateret ved hver ændring og være let tilgængelig i projektets dokumentation, ofte i en fil som CHANGELOG.md eller på projektets hjemmeside.

Råd til praksis: hold sproget neutralt og konsistent, undgå marketing-tale, giv klare beskrivelser af konsekvenser og ændringenes omfang, og link til relevante sager eller dokumentation hvis muligt.