Konvence - Git¶

Obecná pravidla¶

• Hlavní větví v projektu je master. V této větvi se vždy nachází poslední funkční revize projektu.
• Do větve master se přímo necommituje.
• Popisky commitů jsou v anglickém jazyce.
• 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).

Základní tok¶

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.

Feature větve se na konci svého života připojují do větve master pomocí Merge Requestů.

Merge requesty¶

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.

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:

• pokud není funkcionalita v dané větvi dokončena, měla by hodnota být nastavena na člena týmu, který na ní pracuje
• 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