Konvence pro vývoj » Historie » Verze 4
Patrik Harag, 2019-04-04 16:18
| 1 | 1 | Přemysl Kouba | h1. Konvence pro vývoj |
|---|---|---|---|
| 2 | |||
| 3 | h2. Formátování zdrojových kódů |
||
| 4 | |||
| 5 | Zdrojové kódy jsou formátovány s ohledem na již vytvořený kód. Ty přibližně odpovídají výchozímu nastavení IntelliJ IDEA. |
||
| 6 | |||
| 7 | Pozn.: |
||
| 8 | * pro odsazení slouží 4 *mezery* |
||
| 9 | * závorky u příkazů if, for, while... se vždy píší |
||
| 10 | |||
| 11 | V případě nejasností je možné se řídit například tímto dokumentem: https://cs.brown.edu/courses/cs018/content/docs-spec/java-style.pdf |
||
| 12 | |||
| 13 | 2 | Patrik Harag | h2. Komentáře a javadoc |
| 14 | |||
| 15 | * anglicky |
||
| 16 | * především tam, kde to má smysl |
||
| 17 | |||
| 18 | 1 | Přemysl Kouba | h2. Práce s Gitem |
| 19 | |||
| 20 | 3 | Patrik Harag | * commit messages |
| 21 | ** anglicky |
||
| 22 | ** ideálně podle: https://chris.beams.io/posts/git-commit/ |
||
| 23 | ** na konci issue id v závorce |
||
| 24 | ** příklad: <pre>Improve db configuration (#123)</pre> |
||
| 25 | 1 | Přemysl Kouba | * po každém commitu musí program konzistentní a musejí procházet všechny testy |
| 26 | * je preferováno commitování do master branch (Continuous Integration) |
||
| 27 | * v případě zvýšeného rizika, prototypování apod. je možné vytvořit feature branch, která se, co nejdříve, po stabilizaci sloučí s master branch |
||
| 28 | 3 | Patrik Harag | |
| 29 | 4 | Patrik Harag | h2. Redmine |
| 30 | 3 | Patrik Harag | |
| 31 | // TODO |