Konence TSP2 » Historie » Verze 2
Zdeněk Vavřička, 2024-10-10 07:18
| 1 | 2 | Zdeněk Vavřička | h1. Konvence |
|---|---|---|---|
| 2 | |||
| 3 | --- |
||
| 4 | |||
| 5 | h2. Iterace |
||
| 6 | |||
| 7 | * Iterace budou na začátku projektu po jednom týdnu, jakmile se začne s implementací, prodlouží se na dva týdny |
||
| 8 | * Iterace začínají a končí v pátek |
||
| 9 | |||
| 10 | h2. Interní pravidla |
||
| 11 | |||
| 12 | * Tým bude mít pravidelné schůzky v pondělí a pátek |
||
| 13 | * Členové týmu vykazují hodiny každý den |
||
| 14 | |||
| 15 | h2. Úkoly |
||
| 16 | |||
| 17 | h3. Druh |
||
| 18 | |||
| 19 | * Task - schůzky, dokumentace, správa wiki, analýza |
||
| 20 | * Feature - implementace, testování |
||
| 21 | * Bug - oprava chyb |
||
| 22 | |||
| 23 | h3. Kategorie |
||
| 24 | |||
| 25 | * Analýza - analýza projektu a návrh řešení |
||
| 26 | * Dokumentace - správa dokumentů a wiki |
||
| 27 | * Implementace - implementace řešení a oprava chyb |
||
| 28 | * Schůzka - schůzka |
||
| 29 | * Testování - testování |
||
| 30 | |||
| 31 | h3. Stav |
||
| 32 | |||
| 33 | * New - nově vytvořený, nepřiřazený úkol |
||
| 34 | * Assigned - již přiřazený úkol |
||
| 35 | * Resolved - úkol je hotový a připraven na kontrolu týmem/vedoucím týmu |
||
| 36 | * Closed - úkol je zkontrolován a uzavřen |
||
| 37 | |||
| 38 | h2. Jazyk |
||
| 39 | |||
| 40 | * V češtině se bude psát veškerá dokumentace, wiki, komentáře |
||
| 41 | * V angličtině pouze kód |
||
| 42 | |||
| 43 | h2. Git |
||
| 44 | |||
| 45 | Celý Git bude v AJ, tedy všechny commit message, branch names, tag names, ... |
||
| 46 | |||
| 47 | h3. Větve |
||
| 48 | |||
| 49 | * hlavní větev je @main@ |
||
| 50 | ** v ní se nikdy nepracuje |
||
| 51 | ** budou se jen mergovat všechny změny ve větvi @dev@ na konci iterace |
||
| 52 | ** merge z @dev@ do @main@ budou otagované |
||
| 53 | * hlavní vývojová větev je @dev@ |
||
| 54 | ** sem se mergují změny z ostatních větví (opravy, nové funkcionality atd.) |
||
| 55 | * větev pro opravy je @fix@ |
||
| 56 | * větev pro nové funkcionality je @feat@ |
||
| 57 | * každý úkol je ve vlastní větvi |
||
| 58 | * nové větve vytvářet z @dev@ větve a průběžně rebaseovat |
||
| 59 | ** @git switch -c <branch-name>@ - vytvoření nové větve |
||
| 60 | ** @git rebase dev@ - rebase na aktuální stav @dev@ větve |
||
| 61 | * větve se pojmenovávají ve formátu @feat/<issue>-<name>@ |
||
| 62 | ** níže jsou příklady vytvoření nových @feat@ a @fix@ větví |
||
| 63 | ** @git switch -c feat/12345-improve-user-form@ |
||
| 64 | ** @git switch -c fix/12345-memory-leak@ |
||
| 65 | * větve by *neměly* obsahovat znak @#@ - kolize pro komentář |
||
| 66 | * vytváření větve na remotu pomocí: @git push -u origin <branch-name>@ |
||
| 67 | ** na GitLabu se objeví možnost vytvořit merge request |
||
| 68 | ** úkol dát do *Draft* fáze, assignovat sobě, assignovat reviewera a nastavit labely (Work in progress / Code review) |
||
| 69 | |||
| 70 | h3. Commity |
||
| 71 | |||
| 72 | * každý commit se vždy váže *pouze na jednu* issue (z principu, ale také kvůli logování času) |
||
| 73 | * commity jsou v tomto formátu: @git commit -m "re #<issue> @<time> - <message>"@ |
||
| 74 | ** @re@ - důležité klíčové slovo pro linkování commitu s issue |
||
| 75 | ** @<issue>@ - číslo issue |
||
| 76 | ** @<time>@ - čas, který commit zabral |
||
| 77 | *** možné formáty zadávání času pro 1 hodinu a 15 minut |
||
| 78 | *** @1h15@ nebo @1.25@ nebo @1,25@ |
||
| 79 | ** @<message>@ - krátký popis, co se v commitu dělalo |
||
| 80 | * příklady commitů: |
||
| 81 | ** @git commit -m "re #69420 @1h30 - removed comments"@ |
||
| 82 | ** @git commit -m "re #42069 - refactor code@ - chybí log času, pak se musí udělat manuálně v Redmine |
||
| 83 | * jak pullovat a pushovat: |
||
| 84 | ** @git push@ - pushuje změny do větve kterou zrovna trackuji |
||
| 85 | ** @git push -f@ - force push, používat pouze pro větev kde pracuju |
||
| 86 | ** @git pull@ - updatuje změny větve |