Changelog Markup

Přijde mi to na mysl pokaždé, když se snažím udržovat k nějakému projektu changelog… „Je zde nějaký standardizovaný markup pro changelogy?“ Podle všeho ne, tak jsem si řekl, že si vymyslím vlastní. Něco, co může být lehce čitelné a pochopitelné pro člověka, stejně jako lehce zpracovatelné pro stroj. Pojďme se podívat…

První řádek je (překvapivě) číslo verze. Podporuje formát podle Semantic Versioning 2.0.0 a volitelně může začínat s „v„. Stejně tak může obsahovat datum releasu ve formátu YYYY-MM-DD, oddělené od verze pomlčkou („„).

Pod číslem verze jsou všechny následující odsazené řádky chápany jako záznamy k verzi. První znak („ikonka“) vyjadřuje, jakého typu záznam je, stejně tak jako je možné nakonec řádku přidat do hranatých závorek („[“ a „]„) ticket, ve kterém byla daná věc řešena.

Mohlo by se vám líbit...

Napsat komentář

Vaše emailová adresa nebude zveřejněna. Vyžadované informace jsou označeny *