Projekt

Obecné

Profil

Konvence projektu » Historie » Revize 10

Revize 9 (Jan Jirman, 2019-04-02 17:08) → Revize 10/13 (Jan Jirman, 2019-04-02 17:14)

h1. Konvence projektu 

 h2. Logovanání času v Redmine 

 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.  

 h3. Příklad - čtyři schůze, dva zúčastnění, celkový odhadovaný čas 8h:  

 * -L. Ščurko 8h, J. Jirman 0h-    ... zdá se, že na schůze přišel jen jeden 
 *    L. Ščurko 4h, J. Jirman 4h     ... OK, je patrné, že oba přišli na schůze 

 h2. Vytvoření issue (úkolu) 

 Issue musí mít _Tracker_: 

 * *Support* - všechny schůze (tým, zadavatel, mentor) .. u schůze přidat i _Due date_. 
 * *Task* - práce s dokumenty 
 * *Bug* - oprava/chyba při implementaci 
 * *Enhancement* - implementace a testování 

 h2. Kód a implementace 

 h3. Psaní komentářu:  

 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.  
 Příklad: _//Načítání dat z txt souboru - #<cislo_issue>_     

 Další speciální požadavky na psaní kódu nejsou. *Code review* bude od celého týmu.  

 h2. Commit 

 h3. Vytvoření *Vytvoření ticketů* - vytváření ticketů  

 Vytváření ticketů bude mít jednotný styl:  

 * _Hlavní téma - co se dělá_ ... příklad: Schůze týmu (2. iterace) - první, Wiki stránky - Konvence projektu. 
 * _Hlavní téma_ (pokud není potřeba dále specifikovat) ... příklad: Návrh datového modelu, Vize produktu. 

 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*.  

 *Uzavírání ticketů* - ticket je uzavřen ve chvíli, kdy je stav _Closed_ a _Done_ na 100 %.  

 h3. Commit  

 Ke *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ě. 

 *_<Keywords>_: Re* 

 příklad commitu (z jiného projektu):  
 _úprava deklarace a inicializace - násobné přiřazení pro identifikátory. 
    - pozměněna metoda enterInteger, exitInteger 
 ...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)*_   

 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.