Loggning av projektändringar

Den aktuella versionen av sidan har ännu inte granskats av erfarna bidragsgivare och kan skilja sig väsentligt från versionen som granskades den 25 juni 2018; kontroller kräver 2 redigeringar .

Projektändringsloggning ( engelska  changelog ) är en mjukvaruloggning av ändringar som gjorts i ett stort projekt. Detta projekt kan vara en webbplats eller ett mjukvaruprojekt. Vanligtvis innehåller ändringsloggposter information om buggfixar, nya funktioner och så vidare. De flesta projekt med öppen källkod innehåller ändringsloggen som en av toppnivåfilerna.

Det kanoniska namnet för ändringsfiler är ChangeLog , [1] men kallas ibland för ÄNDRINGAR eller HISTORIA ( NEWS brukar kallas versionsändringsfiler, inte ändringsloggning). Vissa projektunderhållare lägger till suffixet .txt till filnamnet .

Vissa versionskontrollsystem kan generera lämplig information som är lämplig för att logga ändringar.

Format

Ändringsfiler är organiserade enligt objekt som definierar unika ändringar av en funktion eller fil. De flesta ändringsfiler har följande format: [2]

ÅÅÅÅ-MM-DD John Doe <[email protected]> * myfile.ext(minfunktion): mina ändringar gjorda ytterligare ändringar * myfile.ext (unrelated_change): mina ändringar gjorda till myfile.ext men helt orelaterade till ovanstående * anotherfile.ext (någon funktion): fler ändringar

Observera att det finns mellanslag mellan datum och namn och sedan mellan namn och e-postadress. Det är också en regel att bifoga en e-postadress inom citattecken < och >. Dessa extra ändringsloggposter läggs till av Emacs editor .

Loggar Wikipedia ändringar

De flesta Wiki -projektprogramvara innehåller en ändringslogg som en grundläggande funktion (ofta kallad historia i detta sammanhang ). Till exempel, länken "Historik" högst upp i Wikipedia -fönstret tar dig till artikelns ändringsloggsida. Den här funktionen är avgörande för att uppfylla tillskrivningskraven för vissa upphovsrättslicenser.

Se även

Anteckningar

  1. GNU automake manual . Datum för åtkomst: 27 december 2011. Arkiverad från originalet 27 december 2011.
  2. GNU Coding Standards: Style of Change Logs . Datum för åtkomst: 27 december 2011. Arkiverad från originalet den 26 december 2011.

Länkar