Konvence pro vývoj » Historie » Revize 10
Revize 9 (Přemysl Kouba, 2019-04-25 21:22) → Revize 10/11 (Patrik Harag, 2019-04-27 09:30)
h1. Konvence pro vývoj
h2. Formátování zdrojových kódů
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.
Pozn.:
* pro odsazení slouží 4 *mezery*
* závorky u příkazů if, for, while... se vždy píší
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
h2. Komentáře a javadoc
* anglicky
* především tam, kde to má smysl
h2. Práce s Gitem
* commit messages
** anglicky
** ideálně podle: https://chris.beams.io/posts/git-commit/
** na konci issue id v závorce
** příklad: <pre>Improve db configuration (#123)</pre>
* po každém commitu musí program konzistentní a musejí procházet všechny testy
* je preferováno commitování do master branch (Continuous Integration)
* 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
* po dokončení klíčové feature je vhodné vytvořit tag se jménem ve formátu: feature-XXX
h2. Javascript
[[Konvence pro vývoj (Javascript)]]
*Zpět na [[Wiki#Konvence]]*