Požadavky na studentskou práci

Budete pracovat na vlastních projektech. Během práce musíte plnit následující požadavky:

1. Průběžná práce na GitHubu

Práce bude průběžně ukládána do veřejného repozitáře na GitHubu.
Během týdne musí proběhnout vaše aktivita. Aktuální týden se počítá vždy od pondělí do neděle (23:59).
Alespoň 3 commity týdně: Během tohoto období musíte provést minimálně tři smysluplné commity.
Pravidlo 12 hodin: Mezi každým ze tří povinných commitů musí uběhnout časový rozestup alespoň 12 hodin. (Nesmíte odevzdat vše naráz v neděli večer).

2. Kvalita commitů

Commit musí být smysluplně popsán.
Popis ponese stručnou informaci (v trpném nebo minulém čase, např. Přidána kalkulačka, Opravena chyba) odpovídající změnám, které jste v dané dávce kódu opravdu provedli.

3. Komentování kódu

Kód, který vytvoříte, musí být smysluplně okomentován.
Zaměřte se zejména na logicky složitější části, smyčky a funkce.

4. Technická dokumentace

Souběžně s programováním budete tvořit reálnou technickou dokumentaci k projektu.
Nejedná se o sloh "jak jsem klikal v editoru", ale o tzv. User Guide a technický popis struktury vašeho programu.

Do skriptů a na GitHub nevkládejte, žádné osobní údaje (jméno, příjmení, e-mail, telefon, adresa atd.)!

Postup práce a struktura repozitáře

Výběr názvu: Vyberete si název projektu a zaznamenáte ho do hlavní tabulky v souboru README.md v kořeni repozitáře. Jinými slovy stanovíte si cíl!
Organizace souborů: Každý projekt musí mít svou vlastní samostatnou složku. Veškerý kód, modely a obrázky k danému projektu budou pouze uvnitř této složky (např. složka 01_snake).
Dokumentace projektu: Projekt stručně popíšete a dokumentaci uložíte do souboru ve formátu:
- Název musí končit slovem _projekt.md (např. 01_Snake_hra_projekt.md).
- Soubor musí být umístěn přímo uvnitř složky daného projektu.

[!IMPORTANT] Než začnete pracovat na samotném kódu projektu, musíte si vybrat jeho název a popsat jej v souborech README.md a [nazev]_projekt.md. V souboru README.md jsou postupně uváděny názvy projektů a jejich stručné popisy. Soubor [nazev]_projekt.md je vždy uložen ve složce konkrétního projektu a obsahuje podrobnější popis projektu.

Šablony souborů

Formát souboru `README.md`

Pořadové číslo, název projektu, datum zápisu (pro vaši vlastní evidenci do budoucna).

Formát souboru `projekt.md`

Obsah dokumentace (vytvářena souběžně)

Dokumentace bude obsahovat následující informace: * Název projektu, na kterém pracujete. * Popis a cíl projektu. * Popis funkcionality programu. * Technická část: použité knihovny, algoritmy, vlastní datové struktury, nebo volání externího API atd.