Konvence projektu¶

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.

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

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í

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.

Kód a implementace¶

Kód¶

Celý kód projektu bude napsaný v anglickém jazyce, jakékoliv komentáře budou česky.

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řípadně vytvořené nové třídy nebo metody se číslo issue zapíše do dokumentačního komentáře
Příklad:

//Načítání dat z txt souboru - #<cislo_issue>
/** Třída/Metoda pro načítání dat - #<cislo_issue> */

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

Commit¶

Vytvoř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 %.

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.