diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..90cc33f --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,54 @@ +# AGENTS.md + +Diese Datei definiert, wie der Coding-Agent in diesem Repository arbeiten soll. + +## Ziel +- Schnell, pragmatisch und sauber am Projekt arbeiten. +- Änderungen nachvollziehbar halten. +- Risiken früh sichtbar machen. + +## Projektkontext +- Projektname: `wedding-app` +- Hauptidee: + - TODO: Kurz in 2-4 Sätzen beschreiben, was die App lösen soll. +- Status: + - TODO: MVP / in Entwicklung / produktiv + +## Tech-Stack +- Backend: TODO +- Frontend: TODO +- Datenbank: TODO +- Deployment: TODO + +## Arbeitsregeln für den Agenten +- Erst lesen, dann ändern. +- Kleine, gezielte Änderungen statt großer unkontrollierter Umbauten. +- Bestehende Patterns im Code respektieren. +- Keine destruktiven Git-Befehle ohne explizite Freigabe. +- Bei Unsicherheit Annahmen klar nennen. + +## Code-Standards +- Lesbarkeit vor Cleverness. +- Funktions- und Variablennamen eindeutig wählen. +- Kommentare nur dort, wo Logik sonst nicht sofort klar ist. +- Keine unnötigen Abhängigkeiten hinzufügen. + +## Tests & Validierung +- Nach Änderungen relevante Tests ausführen. +- Wenn keine Tests vorhanden sind: + - Mindestens Smoke-Test beschreiben und durchführen. +- Bei nicht ausführbaren Tests Grund dokumentieren. + +## Dokumentation +- README aktuell halten bei: + - Setup-Änderungen + - neuen Umgebungsvariablen + - neuen Commands + - Architekturänderungen +- Wichtige Entscheidungen kurz als Decision Log festhalten. + +## Decision Log +- YYYY-MM-DD: Entscheidung, Grund, Auswirkung + +## Nächste Schritte (laufend pflegen) +- TODO: wichtigste offene Aufgaben als kurze Liste