Protokolování změn projektu

Aktuální verze stránky ještě nebyla zkontrolována zkušenými přispěvateli a může se výrazně lišit od verze recenzované 25. června 2018; kontroly vyžadují 2 úpravy .

Protokolování změn projektu ( anglicky  changelog ) je softwarové protokolování změn provedených ve velkém projektu. Tímto projektem může být webová stránka nebo softwarový projekt. Záznamy changelogu obvykle obsahují informace o opravách chyb, nových funkcích a tak dále. Většina open source projektů obsahuje changelog jako jeden ze souborů nejvyšší úrovně.

Kanonický název pro soubory změn je ChangeLog , [1] , ale někdy se označuje jako CHANGES nebo HISTORY ( NOVINKY se obvykle nazývají soubory změn verzí, nikoli protokolování změn). Někteří správci projektu přidávají k názvu souboru příponu .txt .

Některé systémy správy verzí jsou schopny generovat příslušné informace, které jsou vhodné pro protokolování změn.

Formát

Soubory změn jsou organizovány podle položek, které definují jedinečné změny funkce nebo souboru. Většina souborů změn má následující formát: [2]

YYYY-MM-DD John Doe <[email protected]> * myfile.ext (moje funkce): provedené změny dodatečné změny * myfile.ext (unrelated_change): mé provedené změny na myfile.ext, ale zcela nesouvisející s výše uvedeným * otherfile.ext (nějaká funkce): další změny

Všimněte si, že mezi datem a jménem a poté mezi jménem a e-mailovou adresou jsou mezery. Rovněž je pravidlem uzavírání e-mailové adresy do uvozovek < a >. Tyto extra záznamy changeslogu přidává editor Emacs .

Protokolování změn Wikipedie

Většina softwaru projektu Wiki obsahuje jako základní funkci changelog (v tomto kontextu často označovaný jako historie ). Například odkaz "Historie" v horní části okna Wikipedie vás zavede na stránku se seznamem změn článku. Tato funkce je zásadní pro splnění požadavků na uvedení zdroje některých autorských licencí.

Viz také

Poznámky

  1. Manuál GNU automake . Datum přístupu: 27. prosince 2011. Archivováno z originálu 27. prosince 2011.
  2. GNU kódovací standardy: Styl protokolů změn . Datum přístupu: 27. prosince 2011. Archivováno z originálu 26. prosince 2011.

Odkazy