Mitwirken an Behörden-KlarText

Vielen Dank, dass Sie sich die Zeit nehmen, Behörden-KlarText zu unterstützen! Wir freuen uns über jede Form der Beteiligung – sei es durch das Melden von Fehlern, Verbesserungsvorschläge, Dokumentationsarbeit oder Code-Beiträge.

Verhaltenskodex (Code of Conduct)

Wir legen Wert auf ein offenes, freundliches und inklusives Umfeld. Wir erwarten von allen Beteiligten einen respektvollen Umgang miteinander. Belästigung oder Diskriminierung jeglicher Art werden nicht toleriert.

Für Details beachten Sie bitte unseren Code of Conduct. Wir orientieren uns zudem an den Coding und Security Grundsätzen von openCoDE.

Wie Sie beitragen können

Fehler melden und Features vorschlagen

Haben Sie einen Fehler gefunden oder eine Idee für eine neue Funktion?

Prüfen Sie zunächst die bestehenden Issues, ob das Thema bereits behandelt wird.
Falls nicht, eröffnen Sie ein neues Issue.
Beschreiben Sie das Problem oder den Vorschlag so präzise wie möglich.

Meldung von Sicherheitslücken

Bitte melden Sie sicherheitsrelevante Probleme, Schwachstellen oder Fehler, die sensible Informationen enthalten, niemals über den Issue Tracker oder öffentlich. Stattdessen sollten sensible Fehlerberichte direkt an behoerden-klartext@pd-g.de gesendet werden.

Code beisteuern

Wenn Sie Änderungen am Code vornehmen möchten:

Issue zuweisen: Suchen Sie sich ein Issue, an dem Sie arbeiten möchten, oder erstellen Sie eines zur Diskussion Ihrer geplanten Änderung.
Branch erstellen: Erstellen Sie einen neuen Branch für Ihre Arbeit (keine direkten Commits auf main).
Entwicklung: Implementieren Sie Ihre Änderungen.
Tests: Schreiben Sie Tests für neue Funktionen und stellen Sie sicher, dass alle bestehenden Tests erfolgreich durchlaufen.
Merge Request (MR): Erstellen Sie einen Merge Request gegen den main-Branch. Füllen Sie die MR-Beschreibung sorgfältig aus.

Entwicklungsrichtlinien

Um die Code-Qualität und Wartbarkeit zu gewährleisten, bitten wir um Einhaltung folgender Standards:

Coding Standards

Sprache: Code-Kommentare, Docstrings und technische Dokumentation sind in Englisch zu verfassen.
Python Style: Wir orientieren uns am Google Python Style Guide.
Tooling: Wir verwenden Ruff für Linting und Formatierung anstelle von Pylint/Black.
Sauberer Code: Achten Sie auf Lesbarkeit und vermeiden Sie unnötige Komplexität.

Testing

Die CI/CD-Pipeline (GitLab) führt automatisch Tests und Qualitätschecks durch. Ein Merge ist nur bei "grüner" Pipeline möglich.

Dokumentation

Aktualisieren Sie Docstrings bei Änderungen an Funktionen/Klassen.
Passen Sie bei Bedarf die Markdown-Dateien im docs-Ordner an.

Lizenz

Durch das Einreichen von Beiträgen (Code, Dokumentation, etc.) erklären Sie sich damit einverstanden, dass Ihre Arbeit unter der im Projekt verwendeten Lizenz (Apache 2.0) veröffentlicht wird.

Sie haben noch Fragen?

Erstellen Sie ein Issue oder nehmen Sie gerne direkt Kontakt mit dem Projektteam über unsere Kontaktseite auf.