Wir freuen uns über Beiträge von Entwicklern, technischen Redakteuren und allen, die daran interessiert sind, die Analyse von Kontoauszügen für die Finanzwelt zu verbessern.
So leisten Sie einen Beitrag
Probleme melden
Haben Sie einen Fehler gefunden oder haben Sie eine Funktionsanfrage? Öffnen Sie ein Problem auf GitHub. Bitte beifügen:
- Eine klare Beschreibung des Problems oder Vorschlags.
- Schritte zur Reproduktion (bei Fehlern).
- Ihre Python-Version und Ihr Betriebssystem.
Code senden
- Forken Sie das Repository.
- Erstellen Sie einen Feature-Zweig (
git checkout -b feature/your-feature). - Schreiben Sie Tests für Ihre Änderungen (wir benötigen eine Filialabdeckung von 100 %).
- Führen Sie die Testsuite aus:
pytest. - Senden Sie eine Pull-Anfrage mit einer klaren Beschreibung.
Dokumentation verbessern
Verbesserungen der Dokumentation sind jederzeit willkommen. Du kannst:
- Korrigieren Sie Tippfehler oder klären Sie vorhandene Inhalte.
- Fügen Sie dem [Beispielverzeichnis] neue Anwendungsbeispiele hinzu(https://github.com/sebastienrousseau/bankstatementparser/tree/main/examples).
- Dokumentzeichenfolgen im Quellcode verbessern.
Entwicklungs-Setup
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
pytest # Run the test suite
Code-Standards
- Der gesamte Code muss bestehen
ruffFlusen undmypyTypprüfung. - Alle Commits müssen signiert sein. – Alle Pull-Anfragen müssen eine Zweigabdeckung von 100 % gewährleisten.
- Befolgen Sie den vorhandenen Codestil und die vorhandenen Muster.
Sponsern Sie das Projekt
Wenn Bank Statement Parser Ihrem Team Zeit spart, denken Sie darüber nach, das Projekt auf GitHub zu sponsern. Ihre Unterstützung hilft uns, die Bibliothek zu erhalten und zu verbessern.