45 lines (31 loc) · 1.26 KB

Contributing

Vielen Dank für dein Interesse an Beiträgen zu Paperless KIplus.

Voraussetzungen

Home Assistant Testumgebung
Zugriff auf eine Paperless-ngx Instanz (für Integrations-Tests)
Python 3

Entwicklungsprinzipien

Kleine, nachvollziehbare Änderungen pro Pull Request
Klare Commit-Messages (Deutsch oder Englisch, technisch präzise)
Robuste Fehlerbehandlung mit verwertbaren Logs
Rückwärtskompatibilität für bestehende Nutzerkonfigurationen

Lokale Checks

Vor einem PR bitte mindestens:

Syntax prüfen:
- python3 -m py_compile custom_components/paperless_kiplus/*.py src/paperless_ai_sorter.py
Integration laden und einen Testlauf in Home Assistant durchführen
Prüfen, dass README/Docs bei neuen Features aktualisiert sind

Pull-Request Ablauf

Fork/Branch erstellen
Änderung umsetzen
Tests/Checks durchführen
Pull Request mit klarer Beschreibung einreichen

Bitte im PR enthalten:

Was wurde geändert?
Warum ist die Änderung nötig?
Welche Risiken/Nebenwirkungen gibt es?
Wie wurde getestet?

Versionierung und Releases

Bei Änderungen, die Nutzer betreffen, wird die Version in custom_components/paperless_kiplus/manifest.json erhöht.
Releases werden über Git-Tags veröffentlicht.