Projekt

Obecné

Profil

Konvence projektu » Historie » Verze 9

Jan Jirman, 2019-04-02 17:08

1 1 Jan Jirman
h1. Konvence projektu
2
3
h2. Logovanání času v Redmine
4
5 3 Jan Jirman
Každý zúčastněný člen týmu na jakékoliv schůzi je povinen zalogovat svůj strávený čas. Nelze tedy, aby issue uzavřel pouze jeden člověk za všechny - nedojde tak k nakupení hodin pouze pro jednoho člena. 
6 1 Jan Jirman
7 4 Jan Jirman
h3. Příklad - čtyři schůze, dva zúčastnění, celkový odhadovaný čas 8h: 
8 2 Jan Jirman
9 1 Jan Jirman
* -L. Ščurko 8h, J. Jirman 0h-  ... zdá se, že na schůze přišel jen jeden
10
*  L. Ščurko 4h, J. Jirman 4h   ... OK, je patrné, že oba přišli na schůze
11 4 Jan Jirman
12
h2. Vytvoření issue (úkolu)
13
14
Issue musí mít _Tracker_:
15
16 5 Jan Jirman
* *Support* - všechny schůze (tým, zadavatel, mentor) .. u schůze přidat i _Due date_.
17
* *Task* - práce s dokumenty
18 1 Jan Jirman
* *Bug* - oprava/chyba při implementaci
19
* *Enhancement* - implementace a testování
20 5 Jan Jirman
21
h2. Kód a implementace
22
23 6 Jan Jirman
h3. Psaní komentářu: 
24
25
Při hůře pochopitelném kódu je dobré zapsat komentář, co daný kód dělá. Pro lepší vyznání změn v kódu je vhodné zapsat jméno issue. 
26 7 Jan Jirman
Příklad: _//Načítání dat z txt souboru - #<cislo_issue>_    
27 5 Jan Jirman
28 6 Jan Jirman
Další speciální požadavky na psaní kódu nejsou. *Code review* bude od celého týmu. 
29 1 Jan Jirman
30 7 Jan Jirman
h2. Commit
31
32 8 Jan Jirman
*Vytvoření ticketů* - vytváření ticketů bude mít jednotný styl: 
33
34
* _Hlavní téma - co se dělá_ ... příklad: Schůze týmu (2. iterace) - první, Wiki stránky - Konvence projektu.
35
* _Hlavní téma_ (pokud není potřeba dále specifikovat) ... příklad: Návrh datového modelu, Vize produktu.
36
37
Ticket vytvoří jeden pověřený člověk týmu - vytvořením a přiřazením nějakému členu týmu je i ticket *schválen*. 
38
39
*Uzavírání ticketů* - ticket je uzavřen ve chvíli, kdy je stav _Closed_ a _Done_ na 100 %. 
40
41
*Commit* - ke každému commitu *musí být vytvořen ticket*. Každý commit musí mít svůj komentář, co se vytvořilo/změnilo a podobně. Dále na konci takového komentáře dát do závorky číslo ticketu - v commit message používat syntaxi ve tvaru *<keyword> #<číslo_ticketu>*. To umožní k úkolům vypisovat související commity do uložiště.
42
43
*_<Keywords>_: Re*
44
45
příklad commitu (z jiného projektu): 
46
_úprava deklarace a inicializace - násobné přiřazení pro identifikátory.
47
   - pozměněna metoda enterInteger, exitInteger
48
...Nyní HashMap iniciallization říká, jestli proměnná vůbec existuje a jestli je iniciallizovaná - do variables se proměnná přidává ve chvíli, kdy je inicializovaná *(Re #1234)*_  
49
50 9 Jan Jirman
Více k syntaxi commit message na: https://students.kiv.zcu.cz:3443/projects/redmine-manual/wiki/Prost%C5%99ed%C3%AD_projektu#fora v Poznámky k úkolům.