A hallgatóknak egy külön erre a célra létrehozott GitHub repositoryban kell dolgozniuk. Elegendő csak az egyik hallgatónak létrehozni egy GitHub repositoryt. Természetesen, mindkét hallgatónak kell hozzáféréssel rendelkezni a repositoryhoz, és egyenlő arányban kell dolgozni a választott feladaton. Ez a git commitokból kell, hogy látszódjon. Az elkészített dokumentációkat a repository /wiki szekciójába kell elkészíteni kötelező jelleggel. Ehhez Markdown leíró nyelvet használjanak. A kód szekcióban kizárólag csak forráskódokat szabad elhelyezni.
Megjegyzés: Az időjárás-állomás feladatot nem lehet választani!
- tömörített állomány kerül a GitHub repositoryba (pl. zip vagy rar)
- a csapatból csak az egyik hallgató commitol
- túl kevés a commitok száma (pl. '<'10)
- nincs wiki oldal/oldalak
- a dokumentáció pdf/docx-ként lett feltöltve
- a hallgatók File uploadot használnak commit helyett
- a forráskódokat képként illesztik be a dokumentációba a Markdown szintakszisok helyett
- jól követhető és részletes a dokumentáció
- az alap információkat a README fájlba, a dokumentációkat a /wiki-ben helyezik el
- átlátható a repository (rendben vannak az Issuek, Brachek, Commitok, Gitignore, Licensz)
- a repository a feladatnak megfelelően van elnevezve, a leírásban pedig szerepel a tárgykód és a tárgynév
- Elégtelen: nem felel meg a minimális kritériumoknak, akár tartalmilag vagy minőségben
- Elégséges: viszonylag egyszerűbb a feladat, és készül hozzá fejlesztői dokumentáció.
- Közepes: bonyolultabb a feladat és egyaránt készül hozzá fejlesztői és használati dokumentáció
- Jó: a közepes szint elvárásait még ki kell egészíteni valamilyen mérés/adatgyűjtési folyamattal, az adatokat adatbázisba tárolni és onnan valamilyen módon vizualizálni azokat.
- Jeles: a jó osztályzat elvárásait még ki kell egészíteni valamilyen plusz kommunikációs csatornával. Ez lehet pl.: tweet, facebook post, email notification, push üzenet a telefonon, stb. (csak a képzelet szabhat határokat)
- A fejlesztői dokumentáció tartalmazza a feladat kidolgozása során felmerülő összes részletet. (tervezési fázis, felmerülő problémák, áramköri rajzok, felhasznált elemek, hardver specifikációk, szoftver specifikációk, rendszerkövetelmények, a fejlesztett kódok részletezése, képek a kész projektről, stb.)
- A felhasználói útmutató/dokumentáció tartalmazza mindazokat az információklat, melyek szükségesek a modell beüzemeléséhez és rendeltetésszerű használatához egy laikus felhasználó számára.
- A dokumentációkat a repository Wiki szekciójában kell elkészíteni. A formázáshoz pedig Markdown szintakszisokat kell alkalmazni. Ehhez nyújthat induló segítséget az alábbi oldal: Markdown Cheat Sheet