Vývoj s GitHubem a issues

Pavel Git

Issues na GitHubu nejsou pouze pro reportování chyb ostatními, ale lze je použít i pro soukromé repozitáře při vývoji. Jednotlivé issues lze propojit s commity, přiřadit vývojáři, vést diskuzi, notifikovat ostatní členy týmů a mnoho dalšího.

Vývoj s GitHubem a issues

Asi každý někdy viděl u projektu na GitHubu v položce Issues nějaké záznamy. Nejčastěji zde ostatní vývojáři reportují chyby, žádají o nějaké rozšíření nebo jen chtějí radu. I když ta poslední možnost asi není to, k čemu jsou issues určeny.

Issues ale nemusí vytvářet pouze ostatní vývojáři u veřejných projektů. Lze je totiž použít jako vlastní seznam úkol, které je potřeba udělat. Při práci v týmu je navíc možnost u issue určovat zodpovědnou osobu a vést také diskuzi, označovat a třídit issues.

Aktuální článek referuje o použití s GitHubem. Stejný postup ale podporují všechny známé služby jako BitBucket, GitLab a další.

Automatické uzavření commitem a pull-requestem

Největší výhodou je jednoznačně přímé spojení mezi issue a commitem nebo pull-requestem. Každý commit má své ID, které je napsáno za znakem # u názvu, stejně tak má své ID i každý pull-request. Pomocí těchto čísel se dá ve zprávě commitu, textu issue nebo pull-requestu odkazovat mezi nimi navzájem. Stačí vložit znak # a za něj číslo issue nebo pull-requestu a mezi nimi bude automaticky vytvořen odkaz.

Navíc, pokud commit nebo pull request obsahuje kód splňující zadání issue, lze při pushnutí do repozitáře tento issue automaticky uzavřít. Stačí do zprávy commitu přidat text Closes #5, pro zavření issue s ID 5. Pro pull requesty je nutné tyto textové konstrukce přidat do obsahu při vytváření pull requestu. Kromě Closes, je možné také použít Fix #5, Fixes #5, Resolve #5 a pár dalších, které jsou v oficiální dokumentaci.

Issue uzavřena commitem

Označování, notifikace, milníky a tagy

V diskuzi k issue, commitu nebo pull requestu lze označovat ostatní kolegy, kteří by se měli k aktuálnímu tématu vyjádřit. To se dělá zavináčem podobně jako na Twitteru, tj @arxeiss. Při takovém označení jim bude doručena emailová notifikace. Pro pokročilejší užití je zde možnost vytvářet skupiny a označovat jednoduše celou skupinu.

U jednotlivých issue lze také určit osobu, která je za splnění úkolu zodpovědná. Dále je možné pro lepší přehlednost přiřadit několik tagů, které mohou mít svou barvu a titulek. Na závěr je možnost určení milníku, aby bylo jasné, kdy se úkol musí dokončit. Jeho název může být jakýkoli text, a podle milníku je možné všechny issue filtrovat.

Github Issues - milníky a tagy


Využíváte issues na githubu, nebo v jiných nástrojích? Podělte se o zkušenosti v komentáři

Přidat komentář

Právě odpovídáte na existující komentář. Zrušit

Komentáře

Novinky z blogu

Školení - Bezpečnost PHP aplikací

Letos jsem si nadělil Vánoční dáreček o něco dříve. V termínu 11. - 12. prosince jsem se zúčastnil školení od Michala Špačka na téma Bezpečnost PHP aplikací. A jaké že to...

Další články