Podmínky studia

Pravidla a pokyny pro odevzdávání kódu.

Požadavky na studentskou práci a strukturu repozitáře

Váš veřejný GitHub repozitář je rozdělen na dvě hlavní složky v kořeni repozitáře:

  1. Lekce/ – obsahuje veškerou práci realizovanou ve škole během výuky (podrobná pravidla viz sekce Lekce).
  2. Moje_prace/ – obsahuje vaše vlastní domácí projekty, které realizujete doma podle níže uvedených podmínek.

Část A: Domácí projekty – složka Moje_prace

Ve složce Moje_prace/ pracujete samostatně doma na vlastních projektech. Během práce musíte plnit následující požadavky:

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

2. Kvalita commitů

3. Komentování kódu

4. Technická dokumentace


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


Postup práce a organizace ve složce Moje_prace

  1. 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 nebo ve složce Moje_prace/README.md). Jinými slovy stanovíte si cíl!
  2. Organizace souborů: Každý domácí projekt musí mít ve složce Moje_prace/ svou vlastní samostatnou podsložku. Veškerý kód, modely a obrázky k danému projektu budou pouze uvnitř této složky (např. Moje_prace/01_snake).
  3. 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.

DŮLEŽITÉ: 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.


Část B: Školní výuka – složka Lekce

Práce realizovaná přímo ve vyučovacích hodinách patří do složky Lekce/:


Šablony souborů pro domácí projekty (Moje_prace)

Formát souboru README.md

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

Formát souboru [nazev]_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.