Înregistrarea modificărilor proiectului

Versiunea actuală a paginii nu a fost încă examinată de colaboratori experimentați și poate diferi semnificativ de versiunea revizuită pe 25 iunie 2018; verificările necesită 2 modificări .

Înregistrarea modificărilor de proiect ( în engleză  changelog ) este o înregistrare software a modificărilor aduse unui proiect mare. Acest proiect poate fi un site web sau un proiect software. De obicei, intrările din jurnalul de modificări conțin informații despre remedieri de erori, funcții noi și așa mai departe. Majoritatea proiectelor open source conțin jurnalul de modificări ca unul dintre fișierele de nivel superior.

Numele canonic pentru fișierele de modificare este ChangeLog , [1] , dar uneori este denumit SCHIMBĂRI sau ISTORIC ( ȘTIREA este de obicei numită fișiere de modificare a versiunii, nu înregistrarea modificărilor). Unii întreținători de proiect adaugă sufixul .txt la numele fișierului .

Unele sisteme de control al versiunilor sunt capabile să genereze informații adecvate care sunt potrivite pentru înregistrarea modificărilor.

Format

Fișierele de modificare sunt organizate în funcție de elemente care definesc modificări unice la o funcție sau un fișier. Majoritatea fișierelor de modificare au următorul format: [2]

AAAA-LL-ZZ John Doe <[email protected]> * myfile.ext(myfunction): modificările mele efectuate modificări suplimentare * myfile.ext (nerelated_change): modificările mele efectuate la myfile.ext dar complet fără legătură cu cele de mai sus * anotherfile.ext (somefunction): mai multe modificări

Rețineți că există spații între dată și nume și apoi între nume și adresa de e-mail. De asemenea, este o regulă să includeți o adresă de e-mail între ghilimele < și >. Aceste intrări suplimentare din jurnalul de modificări sunt adăugate de editorul Emacs .

Înregistrarea modificărilor Wikipedia

Majoritatea programelor de proiect Wiki includ un jurnal de modificări ca o caracteristică fundamentală (deseori denumită istorie în acest context ). De exemplu, linkul „Istoric” din partea de sus a ferestrei Wikipedia vă duce la pagina de jurnal de modificări a articolului. Această caracteristică este vitală pentru îndeplinirea cerințelor de atribuire ale unor licențe de drepturi de autor.

Vezi și

Note

  1. Manualul GNU Automake . Data accesului: 27 decembrie 2011. Arhivat din original pe 27 decembrie 2011.
  2. Standardele de codare GNU: stilul jurnalelor de modificări . Data accesului: 27 decembrie 2011. Arhivat din original pe 26 decembrie 2011.

Link -uri