Ändringslogg
En ändringslogg är en logg eller post över alla anmärkningsvärda ändringar som gjorts i ett projekt. Projektet är ofta en webbplats eller ett mjukvaruprojekt och ändringsloggen innehåller vanligtvis register över ändringar som buggfixar, nya funktioner etc. Vissa projekt med öppen källkod inkluderar en ändringslogg som en av toppnivåfilerna i distributionen.
En ändringslogg har historiskt inkluderat alla ändringar som gjorts i ett projekt. Sajten "Keep a Changelog" förespråkar istället att en ändringslogg inte inkluderar alla ändringar, utan att den istället ska innehålla "en kurerad, kronologiskt ordnad lista över anmärkningsvärda ändringar för varje version av ett projekt" och inte bör vara en "dump" av en git log "eftersom det här hjälper ingen".
Även om GNU ( Automake ) kanoniska namnkonventionen för filen är ChangeLog , kallas den ibland alternativt som CHANGES eller HISTORY ( NEWS är vanligtvis en annan fil som återspeglar förändringar mellan utgåvor, inte mellan commits). En annan konvention är att kalla det en CHANGELOG . Vissa projektunderhållare kommer att lägga till ett .txt- suffix till filnamnet om ändringsloggen är ren text , ett .md- suffix om det finns i Markdown eller ett .rst -suffix om det finns i reStructuredText .
Vissa revisionskontrollsystem kan generera relevant information för en ändringslogg, om målet är att inkludera alla ändringar.
Formatera
Ändringsloggfiler är organiserade efter stycken, som definierar en unik ändring i en funktion eller fil. GNU-kodningsstandarderna rekommenderar följande format:
ÅÅÅÅ-MM-DD␣␣John Doe␣␣ * myfile.ext (minfunktion): mina ändringar gjorde ytterligare ändringar * myfile.ext (unrelated_change): mina ändringar som gjorts i minfil.ext men helt orelaterade till ovanstående * anotherfile.ext (någon funktion): fler ändringar som jag har gjort
Observera att mellan datumet och namnet, och igen mellan namnet och e-postadressen, finns det två mellanslag vardera. Det är vanligt att bifoga e-postadressen i < och >. Emacs -redigeraren skapar sådana poster när man skapar ytterligare ändringsloggposter.
Ändringsloggar i wikis
De flesta wikiprogramvara innehåller ändringsloggar som en grundläggande funktion (ofta kallad historia i detta sammanhang). Till exempel länken "Visa historik" överst i ett Wikipedia- inlägg länkar till sidans ändringslogg. Denna funktion är avgörande för att uppfylla tillskrivningskraven för vissa upphovsrättslicenser. [ citat behövs ]
Produktändringsloggar
En produktändringslogg kan hålla kunderna informerade om vad som är nytt. Det hjälper till att tillkännage nya funktioner, senaste utgåvor och relevanta nyheter direkt i appen. [ citat behövs ]