3.6 KiB
Přispívání do OpenCanteen
OpenCanteen je aplikace pro přístup do iCanteen. Pokud chcete přispět kód související s komunikací s iCanteen, podívejte se na canteenlib.
Jak přispět do vývoje
Používám GitHub pod protestem
Tento projekt je aktuálně hostován i na GitHubu. To není ideální; GitHub je uzavřený systém plný obchodních tajemství. Doporučuji přečíst si o kampani Give up GitHub od Software Freedom Conservancy pro pochopení proč GitHub není ideální místo pro FOSS projekty.
Příspěvky do kódu přijímám pouze skrz mou Forgejo instanci na adrese https://git.mnau.xyz/hernik/opencanteen
Jakékoli použití kódu pro učení umělých inteligencí, které neumožňuje samotná licence GNU GPL 3.0 či novější, je děláno bez mého souhlasu a vědomí.
Nahlašování chyb
Prosté vyhledání a nahlášení chyby je asi nejjednodušší a zároveň nejpřínosnější způsob přispívání. Stačí vám běžné zařízení a stažená aplikace, pokud objevíte jakoukoliv chybu nebo nesrovnalost, nahlaste ji v Issues.
Při nahlašování chyb se snažte řídit předlohou pro nahlašování chyb, informace, které se nikam nevlezly, napište úplně na konec.
Přidání funkcí nebo oprava chyb
Pokud chcete jakkoliv přispět kódem, jste vítání. Zde následují věci, kterými byste se měli řídit.
Připravení projektu na vašem počítači
Budete potřebovat
- Flutter (poslední stabilní verzi)
- Vývojové prostředí (Doporučuji VS Code)
- Git (není výhradně nutné, ale hodí se pro získání/přidání kódu na GitHub)
Jakmile máte všechno potřebné, forkněte tento repozitář na váš účet.
Poté si váš repozitář stáhněte, buď pomocí tlačítka Code > Download ZIP nebo (máte-li nainstalovaný Git) pomocí příkazu git clone https://github.com/VASEJMENO/opencanteen.
Následně můžete složku otevřít ve vámi preferovaném editoru a začít editovat
Budete-li chtít nahrát změny zpět do vašeho GitHub repozitáře, buďto je nahrajte na webu nebo použijte následující příkazy (jeden po druhém; může vyžadovat přihlášení):
git add .git commit -m 'feature: nové funkce'(Místo "nové funkce" je dobré přidat krátký popis co přidáváte. Tento repozitář se řídí Conventional Commits formátem, ujistěte se, že váš commit je ve stejném formátu)git push main
Přidání kódu zpět do repozitáře
Jakmile máte přidáno všechno, je na čase otevřít pull request v našem repozitáři.
Všechny pull requesty musí být směřovány na jinou větev, než main a jejích název musí odpovídat Conventional Commits formátu, jinak budou automaticky zamítnuty.
Pokuste se v těle pull requestu popsat jaké funkce přidáváte nebo opravujete, případně přidejte odkaz na otevřený problém, pokud s ním souvisí.
Nějaký člověk váš kód zkontroluje a případně okomentuje co byste měl změnit. V případě, že všechno půjde hladce, vám potvrdíme pull request a váš kód se stane součástí.