67 lines (46 loc) · 2.06 KB

Beitragsrichtlinie / Contributing Guide

Deutsch

Vielen Dank für Ihr Interesse, zu diesem Projekt beizutragen.

Wie Sie beitragen können

Bug melden: Erstellen Sie ein Issue mit klaren Schritten zur Reproduktion.
Feature vorschlagen: Beschreiben Sie den Nutzerwert und den betroffenen Workflow.
Code beitragen: Erstellen Sie einen Pull Request mit engem Scope.

Lokales Setup

Python 3.10+ installieren
pip install -r requirements.txt
App mit start.bat oder python main.py starten
Tests mit python -m pytest -q ausführen

Pull Requests

Forken Sie das Repository
Erstellen Sie einen Branch mit klarer Absicht
Halten Sie Änderungen klein und nachvollziehbar
Aktualisieren Sie README/CHANGELOG, wenn Nutzerverhalten oder Releases betroffen sind
Prüfen Sie vor dem PR, dass keine lokalen Tool-Pfade, Tokens oder Release-Artefakte eingecheckt werden

Code-Richtlinien

Python: PEP 8 Stil
Encoding: UTF-8 für alle Dateien
Sprache: Code und Kommentare auf Deutsch oder Englisch
Keine hardcoded Pfade, Secrets oder lokale Windows-spezifische Nutzerdaten committen

English

Thank you for your interest in contributing to this project.

How to Contribute

Report bugs: Open an issue with clear reproduction steps.
Suggest features: Describe the user value and affected workflow.
Contribute code: Open a pull request with a tight, reviewable scope.

Local Setup

Install Python 3.10+
Run pip install -r requirements.txt
Start the app with start.bat or python main.py
Run tests with python -m pytest -q

Pull Requests

Fork the repository
Create a branch with a clear intent
Keep changes small and easy to review
Update README/CHANGELOG when user-visible behavior or releases change
Verify that no local tool paths, tokens, or release artifacts are committed

Code Guidelines

Python: PEP 8 style
Encoding: UTF-8 for all files
Language: Code and comments in German or English
Do not commit hardcoded paths, secrets, or local Windows user data