Mitwirken

Beiträge zu diesem Projekt sind willkommen!

Wie du mitwirken kannst

• Fehlerberichte: Issue erstellen
• Fragen & Hilfe: Q&A-Diskussion starten
• Funktionswünsche: Idee teilen
• Lovelace & Automationen: Projekt zeigen
• Pull Requests: Fork → Branch → Änderungen → PR
• Dokumentation: Wiki-Seiten verbessern oder neue hinzufügen
• Übersetzungen: Bei DE/EN-Übersetzungen helfen

Entwicklungsumgebung einrichten

1. Forke das Repository
2. Klone den Fork lokal
3. Kopiere custom_components/idm_heatpump/ in dein HA-Verzeichnis custom_components/
4. Aktiviere die Debug-Protokollierung
5. Starte HA neu

Sprache

Das Projekt schreibt auf Englisch: Code, Kommentare, Dokumentation, Changelog-Einträge, Commit-Messages und Beschreibungen von Pull Requests. Deutsch gehört in README_de.md, die de-Übersetzungen von Home Assistant und die deutsche Wiki-Spiegelung unter docs/wiki/de/. Die englischen Wiki-Seiten bleiben die maßgebliche Fassung. Führe python scripts/check_documentation_language.py aus, bevor du einen Pull Request öffnest — tests/test_documentation_language.py bringt den Build zum Scheitern, wenn deutsche Prosa enthalten ist.

Code-Stil

• Verwende Ruff zum Linten und Formatieren
• Folge bei Commit-Messages Conventional Commits
• Halte den Code einfach und verständlich

Pull-Request-Prozess

1. Erstelle einen Fork
2. Erstelle einen Feature-Branch (git checkout -b feat/my-feature)
3. Commite deine Änderungen (git commit -m 'feat: add my feature')
4. Pushe in den Fork (git push origin feat/my-feature)
5. Erstelle einen Pull Request

Lizenz

Mit deinem Beitrag stimmst du zu, dass dein Code unter der MIT-Lizenz veröffentlicht wird.

Dokumentation zusammen mit Code pflegen

Jede neue Funktion, Fehlerkorrektur mit geänderter Bedienung und Felderkenntnis gehört auf die passende englische Wiki-Seite und deren deutsche Spiegelung. Einrichtung, Standardwerte, Aktionen, Datenschutz und Grenzen mitführen. Nachweise und offene Fragen im Erkenntnisregister verlinken. Neue Seiten müssen auch in der Website-Navigation registriert sein.

python scripts/check_wiki_coverage.py meldet neue oder geänderte Quellmodule, fehlende Sprachfassungen und undokumentierte Aktionen. Erst nach der Prüfung beider Sprachen python scripts/check_wiki_coverage.py --update ausführen und den Diff von docs/wiki-coverage.json kontrollieren. Versionsangaben prüft zusätzlich python scripts/check_documentation_versions.py.