Úvod
Analyzátor bankovních výpisů je open-source Python knihovna licencovaná pod Apache 2.0. Vítáme příspěvky od komunity -- ať už jde o opravy chyb, nové funkce, vylepšení dokumentace nebo hlášení problémů.
Jak přispět
Hlášení chyb
Pokud narazíte na chybu, prosím vytvořte issue na GitHub s následujícími informacemi:
- Verze Pythonu a operační systém
- Minimální reprodukovatelný příklad
- Očekávané vs. skutečné chování
- Úplný traceback chyby (pokud je k dispozici)
Požadavky na funkce
Máte nápad na novou funkci? Vytvořte issue na GitHub popisující:
- Případ použití, který chcete řešit
- Navrhované řešení
- Alternativy, které jste zvažovali
Pull requesty
- Forkněte repozitář
- Vytvořte feature branch (
git checkout -b feature/moje-zmena) - Proveďte změny s testy
- Ujistěte se, že všechny testy prochází (
pytest) - Odešlete pull request
Vývojové prostředí
git clone https://github.com/sebastienrousseau/bankstatementparser.git
cd bankstatementparser
python3 -m venv .venv && source .venv/bin/activate
pip install poetry && poetry install --with dev
Spuštění testů
pytest # Všechny testy
pytest --cov # S pokrytím kódu
pytest -x # Zastavit při první chybě
Pravidla pro příspěvky
- Všechen kód musí mít 100% pokrytí testy
- Commity musí být podepsané
- Kód musí projít lintery a formátovacími kontrolami
- Dokumentace musí být aktualizována pro nové funkce
Komunita
- GitHub Issues -- hlášení chyb a požadavky na funkce
- GitHub Discussions -- obecné otázky a diskuse
Děkujeme za váš zájem o přispívání do Analyzátoru bankovních výpisů!