Konvence projektu » Historie » Verze 13
Jan Jirman, 2019-04-23 06:09
| 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 | 13 | Jan Jirman | Pokud je issue hotová, zvolí se stav, který není _Closed_ a dává smysl, že je issue na 100 % (pokud žádný takový stav není, pak se nechá ten, který je). Po zkonzultování a ověření s týmem: Team leader změní stav na _Closed_ a issue je finálně uzavřena. |
| 22 | |||
| 23 | 5 | Jan Jirman | h2. Kód a implementace |
| 24 | |||
| 25 | 12 | Jan Jirman | h3. Kód |
| 26 | |||
| 27 | Celý kód projektu bude napsaný v anglickém jazyce, jakékoliv komentáře budou česky. |
||
| 28 | |||
| 29 | 1 | Jan Jirman | h3. Psaní komentářu: |
| 30 | |||
| 31 | 13 | Jan Jirman | 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řípadně vytvořené nové třídy nebo metody se číslo issue zapíše do dokumentačního komentáře |
| 32 | Příklad: |
||
| 33 | |||
| 34 | _//Načítání dat z txt souboru - #<cislo_issue>_ |
||
| 35 | _/** Třída/Metoda pro načítání dat - #<cislo_issue>_ */ |
||
| 36 | |||
| 37 | 5 | Jan Jirman | |
| 38 | 6 | Jan Jirman | Další speciální požadavky na psaní kódu nejsou. *Code review* bude od celého týmu. |
| 39 | 1 | Jan Jirman | |
| 40 | 7 | Jan Jirman | h2. Commit |
| 41 | |||
| 42 | 10 | Jan Jirman | h3. Vytvoření ticketů |
| 43 | 1 | Jan Jirman | |
| 44 | 10 | Jan Jirman | Vytváření ticketů bude mít jednotný styl: |
| 45 | |||
| 46 | 8 | Jan Jirman | * _Hlavní téma - co se dělá_ ... příklad: Schůze týmu (2. iterace) - první, Wiki stránky - Konvence projektu. |
| 47 | * _Hlavní téma_ (pokud není potřeba dále specifikovat) ... příklad: Návrh datového modelu, Vize produktu. |
||
| 48 | |||
| 49 | 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*. |
||
| 50 | |||
| 51 | 1 | Jan Jirman | *Uzavírání ticketů* - ticket je uzavřen ve chvíli, kdy je stav _Closed_ a _Done_ na 100 %. |
| 52 | |||
| 53 | 10 | Jan Jirman | h3. Commit |
| 54 | |||
| 55 | 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ě. |
||
| 56 | 8 | Jan Jirman | |
| 57 | *_<Keywords>_: Re* |
||
| 58 | |||
| 59 | příklad commitu (z jiného projektu): |
||
| 60 | 11 | Jan Jirman | |
| 61 | 8 | Jan Jirman | _úprava deklarace a inicializace - násobné přiřazení pro identifikátory. |
| 62 | - pozměněna metoda enterInteger, exitInteger |
||
| 63 | ...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)*_ |
||
| 64 | |||
| 65 | 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. |