GitHub

Ako verzovací systém budeme používať GitHub po názvom organizácie smart-brew.

V rámci tejto GitHub organizácie budeme pracovať v nasledovných repozitároch:

• documentation - pre dokumentáciu
• web - pre tímovú stránku
• frontend - GUI pre používateľov
• backend - aplikačný server, ktorý je spojený s databázou a rieši požiadavky z frontendu cez REST API
• websocket-module - ESP32 modul (viac info Moduly)
• module-mock-server - testovací server, ktorý slúži ako náhrada modulu pre lokálny development (viac info Testovací server)
• startup - spustenie systému (viac info Spustenie systému)

Commit

Každý commit bude dodržovať nasledujúci formát

Formát commitov

  typ(jira): popis

• typ je jedným z: feature, fix, chore
• jira je označenie Jira issue (napr. SB-1) - dôležité dodržať názov aby sa dalo linkovať automaticky medzi Jirou
• popis je krátky popis úkonu

Ukážka commitu

+ feature(SB-2): Login page
+ fix(SB-34): Missing files from upload page

Tvorba vetiev

Každá nová fičúra sa bude tvoriť na osobitnej vetve, pričom sa neskôr bude mergovať pomocou Pull request do main vetvy.

Formát vetiev

  typ(jira)/popis

• typ je jedným z: feature, bug, hotfix
• jira je označenie Jira issue (napr. SB-1)
• popis je krátky popis úkonu - všetko malé písmená, pričom slová sú oddelené pomlčkou

Ukážka vetvy

+ Správne
+ feature(SB-2)/login-page
+ bug(SB-34)/missing-files-from-upload-page


- Nesprávne
- feature(SB-2)/Login page                      # nesprávny formát popisu
- bug(34)/missing-files-from-upload-page        # nesprávne označenie Jira issue
- bug(SB-34):missing-files-from-upload-page     # ':' namiesto '/'

Pull request

Názov pre Pull request musí taktiež dodržať istý formát ako pre názvy commitov.

Formát pull request

  typ(jira)/popis

1. Ak sa v Github actions nachádza script, ktorý vykonáva automatický test, musí najprv úspešne prejsť, aby sa mohli zmeny merge-núť
2. Ďalej je potrebné spraviť code review a zapísať tento fakt do Jiry
3. Až následne vykonať merge
4. Uzavrieť issue v Jire