Git nabízí flexibilní strategie větvení, ale co to znamená? Jednoduše řečeno, strategie větvení je soubor pravidel, konvence, která pomáhá týmům a vývojářům – mohou se těmito pravidly a konvencemi řídit a vytvořit novou větev, její tok atd.
Nepoužití vhodných konvencí pojmenování vede ke zmatkům a komplikuje tým údržby kódu. Nemůžeme ignorovat doporučené postupy Git při větvení konvencí pojmenování.
Strategie větvení Git umožňují oddělení práce. Obecně můžeme větve Git rozdělit do dvou kategorií:Regular &Temporary Branches.
Běžné větve Git
Tyto větve budou trvale dostupné ve vašem úložišti. Jejich konvence pojmenování je jednoduchá a přímočará.
- Vývoj (dev ) je hlavní vývojové odvětví. Myšlenkou vývojové větve je provést v ní změny a omezit vývojářům provádět jakékoli změny přímo v hlavní větvi. Změny ve větvi dev procházejí kontrolou a po testování se sloučí s hlavní větví.
- Hlavní (hlavní ) je výchozí větev dostupná v úložišti Git. Měl by být neustále stabilní a neumožňoval žádné přímé odbavení. Sloučit jej můžete až po kontrole kódu. Všichni členové týmu jsou zodpovědní za to, aby byl master stabilní a aktuální.
- QA (QA ), neboli testovací větev, obsahuje veškerý kód pro testování QA a automatizační testování všech implementovaných změn. Než dojde k jakékoli změně v produkčním prostředí, musí projít testem QA, aby získal stabilní kódovou základnu.
Dočasné větve Git
Jak název napovídá, jedná se o větve, které lze v případě potřeby vytvářet a mazat. Mohou být následující:
- Oprava chyby
- Hot Fix
- Větve funkcí
- Experimentální větve
- Větve WIP
Existuje mnoho formátů a konvencí pojmenování doporučených odborníky pro dočasné pobočky.
Zde je jednoduchý pracovní postup větví Git.
Konvence pojmenování větví Git
V tomto článku zkontroluji a podělím se o sedm nejlepších konvencí pojmenování, které jsem osobně používal v minulosti, abych zajistil jejich účinnost.
1. Název větve začněte slovem skupiny
Je to jeden z osvědčených postupů. Skupinovým slovem může být cokoliv, co odpovídá vašemu pracovnímu postupu.
Mám rád krátká slova, jako jsou následující:
Chyba – Chyba, kterou je třeba brzy opravit
WIP – Práce probíhá a jsem si vědom, že nebude brzy dokončen
Když se podíváte na název větve, můžete pochopit, o čem tato větev Git je a její účel.
Podívejte se na níže uvedené příklady:
- bug-logo-alignment-issue – vývojář se snaží vyřešit problém se zarovnáním loga;
- wip-ioc-container-added – větev souvisí s úlohou přidat probíhající kontejner IoC.
2. Použijte jedinečné ID v názvech větví
ID sledování problémů můžete použít v názvu své pobočky. Tuto metodu preferuji, když pracuji na opravě některých chyb. Například:
wip-8712-add-testing-module
Název ukazuje, že se větev vztahuje k úloze přidání testovacího modulu, sledovací ID problému je 8712 a práce právě probíhá.
Další výhodou použití externího sledovacího ID v názvu pobočky je možnost sledovat průběh z externího systému.
3. Jako oddělovače použijte spojovník nebo lomítko
Mnoho vývojářů používá jako oddělovač lomítko a mnoho používá pomlčky. Který z nich použít – záleží na vás a preferencích vašeho týmu.
Můj názor je, že pomlčky usnadňují čtení názvu, takže je to vhodný oddělovač v názvech větví. Můžete použít lomítka, spojovníky a podtržítka. Jde o to být konzistentní.
Použití oddělovače v názvu větve má dvě hlavní výhody:
- Zvyšuje čitelnost a pomáhá předcházet zmatkům;
- Usnadňuje správu, zejména pokud máte co do činění s mnoha pobočkami.
Příklad 1. Název větve Git bez jakéhokoli oddělovače:
featureupgradejqueryversionloginmodule
Příklad 2. Přidáním oddělovače (v tomto případě je to podtržítko) zajistíte, aby byl název větve Git čitelný:
feature_upgrade_jquery_version_login_module
4. Větev Git se jménem autora
Mnoho společností dává přednost přidávání jmen autorů do názvů poboček podle níže uvedeného formátu:
<author>_<branch-type>_<branch-name>Např. rajeev.bera_feature_new-experimental-changes
Tato metoda umožňuje snadné sledování práce a pokroku různých vývojářů s dalšími systémy.
5. Nepoužívejte pouze čísla
Někteří vývojáři používají pouze ID problému v názvu větve, což není užitečné v postupu práce.
Existuje například název pobočky 9912 – co by nám toto magické číslo mělo říct? Znamená to pouze větší zmatek a riziko chyb, zejména při slučování s jinými větvemi git.
6. Vyhněte se současnému používání všech konvencí pojmenování
Míchání a přiřazování všech konvencí pojmenovávání větví Git není nejlepším postupem. Jen to přidává zmatek a komplikuje celkové procesy.
Tým by se měl rozhodnout, jaké konvence pojmenování budou jednou používat v práci, a držet se jich. Konzistence je nejdůležitější věc.
7. Vyhněte se dlouhým popisným názvům pro dlouhověké větve
Základní vlastností názvu pobočky je, že by měl být přesný a informativní. Podívejme se znovu na několik příkladů:
wip_login_module_which_will_used_in_the_public_website
wip_login_module_which_will_used_in_the_internal_website
Tam jsou názvy poboček dlouhé a podrobné. Není to nutné. Místo toho můžete použít následující variantu:
wip_feature_login_module
Tento název je krátký, ale vysvětluje účel této větve.
Závěr
Model větvení Git je výkonný, ale musíte větve řídit správně a efektivně. Jedním z nezbytných faktorů je dodržování stejných konvencí všemi týmy, zejména – konvence pojmenování pro místní úložiště.
Abyste se ujistili, že váš tým používá dohodnuté konvence, prosazujte standardy. Jedním z nejjednodušších způsobů je použití háčků Git, jako je hák před potvrzením. Doufám, že vám poskytne představu o modelech větvení Git a jejich konvenci pojmenování.