Projekt

Obecné

Profil

Konvence pro vývoj » Historie » Revize 4

Revize 3 (Patrik Harag, 2019-04-04 16:17) → Revize 4/11 (Patrik Harag, 2019-04-04 16:18)

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 

 h2. Konvence používání Redmine 

 // TODO