Pokud chcete přispět do projektu a zlepšit jej, Vaše pomoc je velmi vítána. Přispívat můžete různými způsoby:
- můžete nahlásit závadu nebo požadavek v issues;
- můžete diskutovat a odpovídat na dotazy v diskuzích;
- můžete testovat nově přidané funkcionality;
- můžete si udělat fork projektu, udělat úpravy a poslat je zpět formou pull-requestu
Než vytvoříte pull-request, tak si nainstalujte nástroj pre-commit
.
Nainstalujte si závislosti pro vývoj:
pip install -r requirements-dev.txt
Pro kontrolu kvality kódu a dodržování konvencí používáme nástroj pre-commit
. Pro jeho instalaci použijte příkaz:
pre-commit install
Před odesláním změn je důležité ověřit, že Váš kód nezpůsobuje žádné chyby. To můžete udělat pomocí unit testů:
python manage.py test
Před odesláním změn se ujistěte, že jste provedli všechny potřebné kroky:
- Ověřte, že Váš kód splňuje všechny požadavky
pre-commit
. - Ověřte, že všechny testy procházejí.
- Vytvořte novou větev pro Vaše změny.
- Commitněte a pushněte Vaše změny.
- Vytvořte pull request.
Děkujeme za Váš příspěvek do projektu!