Konvence pro vývoj¶

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.

• 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

Komentáře a javadoc¶

• anglicky
• především tam, kde to má smysl

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:

    Improve db configuration (#123)

• 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

Javascript¶

Konvence pro vývoj (Javascript)

Zpět na Wiki