Jurnal de schimbări
Termenul changelog (un împrumut din limba engleză , derivat din unirea termenilor change = change și log = register) este universal utilizat în domeniul proiectării , în special în informatică , în legătură cu proiectarea software-ului . Reprezintă „jurnalul de schimbări”. [1]
Un jurnal de schimbări este o înregistrare a tuturor modificărilor notabile aduse unui proiect. Proiectul este adesea un site web sau un proiect software, iar jurnalul de modificări include de obicei înregistrări ale modificărilor, cum ar fi remedierea erorilor, caracteristici noi etc. Unele proiecte open source includ un jurnal de schimbări ca unul dintre fișierele de nivel superior din distribuția lor.
Un registru de schimbări a inclus istoric toate modificările aduse unui proiect. Site-ul „Păstrează un jurnal de modificări” susține în schimb că un jurnal de schimbări nu include toate modificările, ci ar trebui să conțină „o listă curată și ordonată cronologic de modificări importante pentru fiecare versiune a unui proiect” și nu ar trebui să fie un „dump” al unui git log "pentru că acest lucru nu ajută pe nimeni".
Deși convenția de numire canonică pentru fișier este ChangeLog [2] , uneori se numește alternativ CHANGES sau HISTORY ( NEWS este de obicei un fișier diferit care reflectă modificările între versiuni, nu între comitere). O altă convenție este să o numim CHANGELOG [3] . Unii responsabili de proiect vor adăuga un sufix .txt la numele fișierului dacă jurnalul de schimbări este text simplu, un sufix .md dacă este în Markdown sau un sufix .rst dacă este în text reStructuredText.
Unele sisteme de control al reviziilor pot genera informații relevante adecvate ca jurnal de modificări dacă scopul este de a include toate modificările.
Un jurnal de schimbări Golang reprezintă o serie de modificări ale codului și revizuirea codului asociat.
Caracteristici
Un registru de modificări este în general stocat într-un fișier în format text și colectează, în ordine cronologică, toate referințele posibile de trasabilitate ale fiecărei modificări făcute de la o versiune anterioară la una ulterioară a unui software , până la versiunea curentă. [4]
Elemente
Pentru fiecare modificare, trebuie să raporteze cel puțin lansarea intervenției, autorul, data, descrierea, motivele și, eventual, versiunea. [4]
Format
Fișierele jurnal de modificări sunt organizate în paragrafe, care definesc o modificare unică în cadrul unei funcții sau fișiere. Standardele de codare GNU recomandă următorul format [5] :
AAAA-LL-ZZ John Doe <e-mailul lui John Doe>
* myfile.ext (funcția mea): modificările mele au fost făcute
modificări suplimentare
* myfile.ext (unrelated_change): modificările mele au fost făcute
la myfile.ext dar complet fără legătură cu precedentul
* anotherfile .ext (somefunction): modificări multiple
Este obișnuit să atașați adresa de e-mail în <e>. Editorul Emacs creează aceste intrări atunci când creează intrări suplimentare în jurnalul de modificări.
Jurnal de modificări în wikis
Majoritatea software-ului wiki include registre de schimbări ca o caracteristică cheie (adesea numită istorie în acest context) [6] . De exemplu, linkul „Istoricul vizualizărilor” din partea de sus a unei intrări Wikipedia leagă jurnalul de modificări al paginii respective.
Jurnalul modificărilor produsului
Un jurnal de modificare a produsului ajută clienții să fie la curent cu noutățile. Ajutați să anunțați noi funcții, ultimele versiuni și știri relevante chiar în aplicație.
Notă
- ^ Ce este Changelog-ul? , pe TechGalaxy , 15 ianuarie 2018. Adus pe 13 mai 2020 .
- ^ Manualul GNU automake .
- ^ Păstrați un Changelog , la keepachangelog.com . Adus de 03 septembrie 2019.
- ^ a b Păstrați un Changelog , la keepachangelog.com . Adus de 13 mai 2020.
- ^ GNU Coding Standards: Style of Change Logs , la Gnu.org . Adus de 03 septembrie 2019.
- ^ Ajutor: Page_history .
