Konvence - Git » Historie » Verze 1
Oto Šťáva, 2021-04-05 12:55
| 1 | 1 | Oto Šťáva | h1. Konvence - Git |
|---|---|---|---|
| 2 | |||
| 3 | h2. Obecná pravidla |
||
| 4 | |||
| 5 | * Hlavní větví v projektu je *master*. V této větvi se vždy nachází poslední funkční revize projektu. |
||
| 6 | * Do větve *master* se přímo necommituje. |
||
| 7 | * Popisky commitů jsou v anglickém jazyce. |
||
| 8 | * Popisek každého commitu začíná řetězcem *Re <ticket> -*, kde _ticket_ je číslo ticketu v systému Redmine, kterého se commit týká (pokud takovéto označení dává smysl). |
||
| 9 | |||
| 10 | |||
| 11 | h2. Základní tok |
||
| 12 | |||
| 13 | Do *master* větve až na výjimečné administrativní zákroky přímo necommitujeme. Pro danou vyvíjenou funkcionalitu vždy vytvoříme tzv. _feature větev_ s názvem ve formátu *feature/<ticket>_<summary>*, kde _ticket_ je číslo ticketu v systému Redmine, ke kterému se daná funkcionalita váže, a _summary_ je velmi stručný popisek obsahu větve formátovaný ve _snake_case_. Příkladem takovéto větve může být *feature/1234_inverse_kinematics*. |
||
| 14 | |||
| 15 | _Feature větve_ se na konci svého života připojují do větve *master* pomocí _Merge Requestů_. |
||
| 16 | |||
| 17 | |||
| 18 | h2. Merge requesty |
||
| 19 | |||
| 20 | Kdykoliv během vývoje dané funkcionality, nejpozději však v době, kdy její vývoj skončil, je nutné vytvořit _Merge Request_ (dále jen MR) dané větve v systému _GitLab_. Název MR by měl být ve formátu *Re <ticket> - <summary>*, kde _ticket_ je číslo ticketu v Redmine a _summary_ je stručný popis vyvíjené funkcionality v uživatelsky čitelném formátu v anglickém jazyce (tj. například *Re 1234 - Implement arm visualization using inverse kinematics*). Nad většinou větví bude prováděna operace _squash_ (tj. spojení všech commitů větve do jednoho) - název MR bude tvořit popisek výsledného commitu. |
||
| 21 | |||
| 22 | MR by měl mít vždy nastavené políčko _Assignee_, a to na osobu, která se má aktuálně daným MR zabývat: |
||
| 23 | * pokud není funkcionalita v dané větvi dokončena, měla by hodnota být nastavena na člena týmu, který na ní pracuje |
||
| 24 | * je MR připraven k připojení do větve *master*, měla by být hodnota nastavena na člena týmu, který provede code review a MR přijme |