MQTT-Display-LaserCutter/.github/copilot-instructions.md

31 lines
2.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Copilot Workspace Instructions
Du bist ein KI-gestützter Code-Assistent, der in diesem Projekt verwendet wird, um die Entwicklung zu unterstützen. Bitte beachte die folgenden Anweisungen, um sicherzustellen, dass deine Beiträge zum Projekt konsistent und von hoher Qualität sind. Deine Antworten beginnen immer mit Dev:.
## Projektziele
Diese sind in der README.md definiert. Stelle sicher, dass deine Beiträge auf die Erreichung dieser Ziele ausgerichtet sind.
## Projektstand
Lese den aktuellen Stand des Projekts in der Datei `Implementation-Plan.md`, um sicherzustellen, dass deine Beiträge mit den laufenden Entwicklungen übereinstimmen. Du hast immer den kompletten Überblick über das Projekt und kennst die README.md.
## Sprache
Antworte immer auf **Deutsch** (Dev-Sprache dieses Projekts).
## Terminal-Nutzung
Öffne **keine neue Console/Terminal-Instanz**, wenn bereits eine aktive Shell vorhanden ist.
Verwende stets ein bereits geöffnetes Terminal weiter.
## await_terminal VERBOTEN während laufender Prozesse
Verwende **niemals** `await_terminal` (oder vergleichbare Wait-Befehle), während ein Build, Upload oder sonstiger längerer Prozess läuft.
`await_terminal` **bricht den laufenden Vorgang ab**.
Warte stattdessen passiv der Benutzer meldet das Ergebnis selbst.
## Commit
vor jedem Commit wird die neue Funktionalität mit test_sketches/test_*.cpp getestet. Alle Tests müssen erfolgreich durchlaufen, bevor ein Commit möglich ist. Sollte es keine Test geben, zum Beispiel für die Überprüfung des gesamten Moduls, lasse den Benutzer vor dem Commit die Änderung manuell testen.
### Dokumentation vor dem Commit
- **Bug Fix / kleines Feature** (kein neues Modul, keine neue Phase): Eintrag in `Feature-Requests.md` aktualisieren (Status auf ✅ setzen). `Implementation-Plan.md` wird **nicht** angefasst.
- **Neue Phase / größeres Feature** (neues Modul, neue Architektur): `Implementation-Plan.md` aktualisieren. `Feature-Requests.md` bleibt unberührt.
### Versions Nummer
Die Firmware-Version wird in `platformio.ini` als `build_flag` definiert. Erhöhe die Version hier bei jedem neuen Release (z.B. von `1.0.0` auf `1.1.0`). Frage den Benutzer ob die Version erhöht werden soll, wenn du einen Commit machst, der über Bug Fixes hinausgeht (neue Funktionalität, neues Modul, neue Phase). Bug Fixes werden in der 3. Stelle gepatcht (z.B. `1.0.0``1.0.1`), neue Funktionalität in der 2. Stelle (z.B. `1.0.0``1.1.0`).