Seznam změn - Changelog
Seznam změn je protokol nebo záznam všech pozoruhodných změn provedených v projektu. Projekt je často webový nebo softwarový projekt a seznam změn obvykle obsahuje záznamy změn, jako jsou opravy chyb, nové funkce atd. Některé projekty s otevřeným zdrojovým kódem obsahují seznam změn jako jeden ze souborů nejvyšší úrovně v jejich distribuci.
Seznam změn historicky zahrnoval všechny změny provedené v projektu. Dále jen „Mějte Changelog“ site místo obhajuje, že changelog ne zahrnovat všechny změny, ale že by se namísto toho obsahovat „curated, chronologicky seřazený seznam výrazných změn pro každou verzi projektu“ a neměla by být „dump“ z git log "protože to nikomu nepomůže".
Ačkoli je kanonickou konvencí pojmenování souboru ChangeLog , někdy je alternativně pojmenován jako CHANGES nebo HISTORY ( NEWS je obvykle jiný soubor odrážející změny mezi vydáním, nikoli mezi potvrzeními). Další konvence je nazývat to CHANGELOG . Někteří správci projektu připojí k názvu souboru příponu .txt, pokud je seznam změn prostý text , přípona .md, pokud je v Markdownu , nebo přípona .rst, pokud je v reStructuredText .
Některé systémy kontroly revizí jsou schopné generovat relevantní informace, které jsou vhodné jako seznam změn, pokud je cílem zahrnout všechny změny.
Golang Change Log je synonymem pro sadu změn v kódu a související revize kódu .
Formát
Soubory změn jsou uspořádány podle odstavců, které definují jedinečnou změnu v rámci funkce nebo souboru. Standardy GNU Coding doporučují následující formát:
YYYY-MM-DD John Doe <johndoe@example.com>
* myfile.ext (myfunction): my changes made
additional changes
* myfile.ext (unrelated_change): my changes made
to myfile.ext but completely unrelated to the above
* anotherfile.ext (somefunction): more changes
Všimněte si toho, že mezi datem a jménem a opět mezi jménem a e -mailovou adresou jsou dvě mezery. Běžné je přiložit e -mailovou adresu do <a>. 9.0 vytvoří tyto položky při vytváření dalších záznamů změn.
Seznamy změn ve wiki
Většina softwaru wiki obsahuje seznam změn jako základní funkci ( v této souvislosti se často nazývá historie ). Například odkaz „Zobrazit historii“ v horní části záznamu na Wikipedii odkazuje na seznam změn na této stránce. Tato funkce je životně důležitá pro splnění požadavků na přiřazení některých licencí na autorská práva.
Seznamy změn produktů
Seznam změn produktů umožňuje udržet zákazníky v obraze o tom, co je nového. Pomáhá oznamovat nové funkce, nejnovější verze a relevantní novinky přímo v aplikaci.