Projekt

Obecné

Profil

Konvence » Historie » Revize 18

Revize 17 (Tomáš Ballák, 2020-04-06 16:37) → Revize 18/23 (Tomáš Ballák, 2020-04-06 16:37)

h1. Konvence 

 h2. Redmine 

 * každý si sám za sebe *eviduje strávený čas*, při jeho evidenci *zvýší počet procent* v daném úkolu a *přidá poznámku* k úkolu stručnou informaci o tom, co se řešilo 
 * *úkoly* může *vytvářet* každý z členů týmu (typicky na začátku na iterace při jejím plánování) 
 * *společné úkoly* se budou uzavírat až po společné diskuzi s týmem (např. po _Weekly update_ či po jiné schůzi) a teprve poté se budou nastavovat na status *closed* 
 * úkoly pro menší počet členů může zavírat osoba, která úkol dokončuje 

 h2. Komunikační kanály 

 * textová komunikace *mezi členy týmu* probíhá přes *Slack* v různých kanálech (podle tématu), schůzky přes *Hangouts* 
 * textová komunikace *se zákazníkem a mentorem* se řeší přes *e-mail*, schůzky probíhají přes *Hangouts* 

 h2. Produkční a testovací prostředí 

 * k produkčnímu i testovacímu prostředí je možné se přihlásit jen pomocí vlastního *SSH klíče*, detaily jsou uvedeny v sekci [[Deployment]] 
 * autorizace pomocí hesla není z důvodu bezpečnosti povolena 

 h2. Repozitář zdrojového kódu 

 * vzdálený *repozitář zdrojového kódu* vytvářené aplikace je veden na katedrální instanci _GitLab_: 
 ** https://gitlab.kiv.zcu.cz/aswi/aswi-2020/aswi2020sebela 

 h2. Konvence pro vývoj – IDE, code style 

 * používané *IDE*: *VSCode* 
 * použitá rozšíření v IDE: 
 ** *php-intellisense* 
 *** odkaz: https://marketplace.visualstudio.com/items?itemName=felixfbecker.php-intellisense 
 *** umožňuje detailnější napovídání při psaní kódu v php 
 ** *phpcs fixer* 
 *** odkaz: https://github.com/junstyle/vscode-php-cs-fixer 
 *** hlídá přednastavený standard pro psaní kódu 
 *** při jeho porušení, sám chyby opraví 
 * pro vývoj v php, je nastaven striktně standard *PSR-2* viz https://www.php-fig.org/psr/psr-2/ 
 * standard je hlídán při každém @push@ do repozitáře, pomocí gitlab runneru 
 ** při případném porušení tohoto standardu pipepline spadne a nedovolí tak deploy aplikace na produkční server 

 h3. Standard PSR-2 

 * staví na *PSR-1* 
 * odsazování *4 mezery* 
 * doporučená *délka řádky je 80 znaků* 
 * po deklaraci @namespace@ a po bloku s @use@ deklaracemi má být *1 prázdná řádka* 
 * otevírací složené závorky pro @class@ a @function@ musí být na *nové řádce* *NEPOUŽÍVÁME* 
 * uzavírací složené závorky pro @class@ a @function@ musí být na *nové řádce* za tělem těchto entit 
 * *viditelnost musí být deklarována* na všech *atributech* a *metodách* 
 * @abstract@ a @final@ musí být *deklarovány před viditelností* 
 * kontrolní struktury @if@, @while@, atd. musí mít *za sebou mezery*, *metody* a *funkce* naopak *nesmí* 
 * otevírací složené závorky *kontrolních struktur musí být na stejné řádce*, uzavírací na *novou řádku* za tělem struktury 
 * *otevírací závorky* pro kontrolní struktury *nesmí mít za sebou mezeru* 
 * *uzavírací uzavírací závorky* pro kontrolní struktury *nesmí mít před sebou mezeru*