Konvence » Historie » Verze 19
Tomáš Ballák, 2020-04-06 16:40
| 1 | 1 | Martin Šebela | h1. Konvence |
|---|---|---|---|
| 2 | |||
| 3 | h2. Redmine |
||
| 4 | |||
| 5 | 6 | Martin Šebela | * 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 |
| 6 | 2 | Martin Šebela | * *úkoly* může *vytvářet* každý z členů týmu (typicky na začátku na iterace při jejím plánování) |
| 7 | 6 | Martin Šebela | * *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* |
| 8 | 3 | Martin Šebela | * úkoly pro menší počet členů může zavírat osoba, která úkol dokončuje |
| 9 | 1 | Martin Šebela | |
| 10 | 4 | Martin Šebela | h2. Komunikační kanály |
| 11 | |||
| 12 | * 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* |
||
| 13 | * textová komunikace *se zákazníkem a mentorem* se řeší přes *e-mail*, schůzky probíhají přes *Hangouts* |
||
| 14 | 1 | Martin Šebela | |
| 15 | 7 | Martin Šebela | h2. Produkční a testovací prostředí |
| 16 | 1 | Martin Šebela | |
| 17 | 7 | Martin Šebela | * 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]] |
| 18 | * autorizace pomocí hesla není z důvodu bezpečnosti povolena |
||
| 19 | |||
| 20 | h2. Repozitář zdrojového kódu |
||
| 21 | |||
| 22 | * vzdálený *repozitář zdrojového kódu* vytvářené aplikace je veden na katedrální instanci _GitLab_: |
||
| 23 | 1 | Martin Šebela | ** https://gitlab.kiv.zcu.cz/aswi/aswi-2020/aswi2020sebela |
| 24 | |||
| 25 | 8 | Martin Šebela | h2. Konvence pro vývoj – IDE, code style |
| 26 | 7 | Martin Šebela | |
| 27 | 6 | Martin Šebela | * používané *IDE*: *VSCode* |
| 28 | 7 | Martin Šebela | * použitá rozšíření v IDE: |
| 29 | 5 | Tomáš Ballák | ** *php-intellisense* |
| 30 | *** odkaz: https://marketplace.visualstudio.com/items?itemName=felixfbecker.php-intellisense |
||
| 31 | *** umožňuje detailnější napovídání při psaní kódu v php |
||
| 32 | 9 | Tomáš Ballák | ** *phpcs fixer* |
| 33 | *** odkaz: https://github.com/junstyle/vscode-php-cs-fixer |
||
| 34 | 5 | Tomáš Ballák | *** hlídá přednastavený standard pro psaní kódu |
| 35 | *** při jeho porušení, sám chyby opraví |
||
| 36 | 11 | Tomáš Ballák | * pro vývoj v php, je nastaven striktně standard *PSR-2* viz https://www.php-fig.org/psr/psr-2/ |
| 37 | * standard je hlídán při každém @push@ do repozitáře, pomocí gitlab runneru |
||
| 38 | 19 | Tomáš Ballák | ** při případném porušení tohoto standardu pipepline spadne a nedovolí tak deploy aplikace na produkční server, více na [[Deployment]] |
| 39 | 12 | Tomáš Ballák | |
| 40 | h3. Standard PSR-2 |
||
| 41 | 13 | Tomáš Ballák | |
| 42 | * staví na *PSR-1* |
||
| 43 | * odsazování *4 mezery* |
||
| 44 | * doporučená *délka řádky je 80 znaků* |
||
| 45 | * po deklaraci @namespace@ a po bloku s @use@ deklaracemi má být *1 prázdná řádka* |
||
| 46 | 15 | Tomáš Ballák | * otevírací složené závorky pro @class@ a @function@ musí být na *nové řádce* *NEPOUŽÍVÁME* |
| 47 | * uzavírací složené závorky pro @class@ a @function@ musí být na *nové řádce* za tělem těchto entit |
||
| 48 | 14 | Tomáš Ballák | * *viditelnost musí být deklarována* na všech *atributech* a *metodách* |
| 49 | 1 | Martin Šebela | * @abstract@ a @final@ musí být *deklarovány před viditelností* |
| 50 | 14 | Tomáš Ballák | * kontrolní struktury @if@, @while@, atd. musí mít *za sebou mezery*, *metody* a *funkce* naopak *nesmí* |
| 51 | 15 | Tomáš Ballák | * otevírací složené závorky *kontrolních struktur musí být na stejné řádce*, uzavírací na *novou řádku* za tělem struktury |
| 52 | 17 | Tomáš Ballák | * *otevírací závorky* pro kontrolní struktury *nesmí mít za sebou mezeru* |
| 53 | 18 | Tomáš Ballák | * *uzavírací závorky* pro kontrolní struktury *nesmí mít před sebou mezeru* |