Changelog: Registro di tutte le notevoli modifiche apportate a un progetto
Il termine changelog (lett.
Nell'ambito informatico il log delle modifiche di solito include record di modifiche come correzioni di bug, nuove funzionalità, ecc.
Un changelog ha storicamente incluso tutte le modifiche apportate a un progetto. Il sito "Keep a Changelog" sostiene invece che un changelog non debba includere tutte le modifiche, ma che dovrebbe invece contenere "un elenco curato e ordinato cronologicamente di modifiche importanti per ciascuna versione di un progetto" e non dovrebbe essere un "dump" di un git log "perché questo non aiuta nessuno".
Sebbene la convenzione di denominazione canonica per il file sia ChangeLog, a volte viene alternativamente chiamato CHANGES o HISTORY (NEWS è di solito un file diverso che riflette le modifiche tra i rilasci, non tra i commit). Un'altra convenzione è chiamarlo CHANGELOG. Alcuni manutentori del progetto aggiungeranno un suffisso .txt al nome del file se il changelog è testo semplice, un suffisso .md se è in Markdown, o un suffisso .rst se è in reStructuredText.
Alcuni sistemi di controllo delle revisioni sono in grado di generare le informazioni rilevanti adatte come log delle modifiche se l'obiettivo è includere tutte le modifiche.
Un changelog golang è sinonimo di una serie di modifiche al codice e della revisione del codice associata.
Caratteristiche
Un changelog è generalmente memorizzato in un file di formato testo e raccoglie, in ordine cronologico, tutti i possibili riferimenti di rintracciabilità di ogni modifica effettuata da una versione precedente ad una successiva di un software, fino al rilascio corrente.
Elementi
Per ogni modifica, esso deve riportarne almeno la release di intervento, l'autore, la data, la descrizione, le motivazioni ed eventualmente la versione.
Formato
I file del registro delle modifiche sono organizzati in paragrafi, che definiscono una modifica univoca all'interno di una funzione o di un file. Gli standard di codifica GNU consigliano il seguente formato:
AAAA-MM-GG John Doe* myfile.ext (myfunction): le mie modifiche hanno apportato modifiche aggiuntive * myfile.ext (unrelated_change): le mie modifiche apportate a myfile.ext ma completamente non correlate al precedente * anotherfile .ext (somefunction): più modifiche
È comune racchiudere l'indirizzo e-mail tra
Changelog nei wiki
La maggior parte dei software wiki include i changelog come caratteristica fondamentale (spesso chiamata cronologia in questo contesto). Ad esempio, il link "Visualizza cronologia" nella parte superiore di una voce di Wiki collega al log delle modifiche di quella pagina.
Log delle modifiche del prodotto
Un registro delle modifiche del prodotto consente di tenere i clienti aggiornati sulle novità. Aiuta ad annunciare nuove funzionalità, ultime versioni e notizie pertinenti direttamente nell'app.
Note
Voci correlate
This article uses material from the Wikipedia Italiano article Changelog, which is released under the Creative Commons Attribution-ShareAlike 3.0 license ("CC BY-SA 3.0"); additional terms may apply (view authors). Il contenuto è disponibile in base alla licenza CC BY-SA 4.0, se non diversamente specificato. Images, videos and audio are available under their respective licenses.
®Wikipedia is a registered trademark of the Wiki Foundation, Inc. Wiki Italiano (DUHOCTRUNGQUOC.VN) is an independent company and has no affiliation with Wiki Foundation.