Sdílení kontaktů (CRM: Sdíleníček - plán projektu)¶

Konvence vývoje¶

Jelikož budeme vyvíjet v Javě a JavaScriptu, nejsme vázáni přísnými konvencemi jazyka a proto jsme si ustanovili některá pravidla:

• k odsazení používáme tabulátor(y) [1]. Je doporučené nastavit si ve svém oblíbeném editoru šířku jednoho tabu na 4 mezery
• otevírací závorka začíná na stejném řádku, jako příkaz uvozující blok
• snažíme se dodržovat maximální délku řádku 101 znaků
• na konci řádků nenecháváme mezery
• konce řádků kódujeme pomocí LF
• IDE/editor si zvolí každý dle vlastního uvážení, doporučuje se však používat funkce automatického formátování
• názvy proměnných píšeme cammelCase, názvy tříd začínají velkým písmenem
• píšeme ofenzivní kód - nepoužíváme abstrakci a patterny tam, kde nedávají smysl. Jména dvou návrhových vzorů v názvu třídy by měly vést minimálně k zamyšlení. Vyjímku tvoří generované názvy vhodným nástrojem [2]
• při výběru knihoven dbáme na jednoduchost a přímočarost. Dáváme přednost menším jednoúčelovým knihovnám před velkými pomalými molochy
• komentujeme tam, kde to dává smysl - složitější konstrukce. Jinak se snažíme, aby kód byl samodokumentující - názvy odpovídají činnosti/účelu
• pokud si s něčím nevíme rady, zeptáme se
• na větší funkcionalitu používáme feature branche
• commit o velikosti menší než malé může jít přímo do stagingu/nasteru
• inspirace pro commit message viz [3]

Reference¶

[1] https://www.youtube.com/watch?v=SsoOG6ZeyUI
[2] https://projects.haykranen.nl/java/
[3] http://whatthecommit.com/