Beschreibung
Es gibt keine Entwicklerdokumentation für externe Mitwirkende.
Das erschwert Contributions und bremst die Community-Bildung.
Inhalt
Repository-Struktur
- Welches Repository wofür
- Mono-/Multi-Repo-Entscheidung erklären
Development Setup
- PlatformIO-Umgebung
- ESP32 DevKit vs. NORVI AE01-R
- Lokale Tests (Hardware-in-the-Loop? CI ohne Hardware?)
Coding Guidelines
- C++ Style (wird Google Style verwendet?)
- Commit-Message-Convention
- Homie-Convention-Einhaltung
Branching & Releases
- Git-Flow? GitHub Flow?
- Release-Prozess (Semver?)
- OTA-Update-Prozess
PR-Prozess
- Vorlage
- Review-Anforderungen
- CI/CD (GitHub Actions)
Teststrategie
- Unit-Tests? (PlatformIO test)
- Wie wird ohne Hardware getestet?
- Manuelle Testfälle
Akzeptanzkriterien
Keine Bilder nötig.
Referenz
Aus der Dokumentationsanalyse – P3
Beschreibung
Es gibt keine Entwicklerdokumentation für externe Mitwirkende.
Das erschwert Contributions und bremst die Community-Bildung.
Inhalt
Repository-Struktur
Development Setup
Coding Guidelines
Branching & Releases
PR-Prozess
Teststrategie
Akzeptanzkriterien
CONTRIBUTING.mdim Repository (odercontent/docs/contributing/)Keine Bilder nötig.
Referenz
Aus der Dokumentationsanalyse – P3