From 927f101ba1186547f7e86c4adb02f745ed86059e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maty=C3=A1=C5=A1=20Caras?= Date: Thu, 19 May 2022 16:20:58 +0000 Subject: [PATCH] =?UTF-8?q?docs:=20p=C5=99idat=20stru=C4=8Dn=C3=BD=20n?= =?UTF-8?q?=C3=A1vod=20pro=20p=C5=99isp=C3=ADv=C3=A1n=C3=AD?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ecb1409 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,36 @@ +# 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](https://github.com/hernikplays/canteenlib). + +## Jak přispět do vývoje +### 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](https://github.com/hernikplays/opencanteen/issues/new/choose). + +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](https://flutter.dev) (poslední stabilní verzi) +- Vývojové prostředí (Doporučuji [VS Code](https://code.visualstudio.com)) +- [Git](https://git-scm.org) (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ář](https://docs.github.com/en/get-started/quickstart/fork-a-repo) 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](https://www.conventionalcommits.org/en/v1.0.0/) 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](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) v našem repozitáři. + +Všechny pull requesty **musí** být směřovány na větev `dev` a jejích název musí odpovídat [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) 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í.