31 lines
2.0 KiB
Markdown
31 lines
2.0 KiB
Markdown
# AGENTS (Repository Guidance)
|
|
|
|
## Projektregeln für Agents/Codex
|
|
1. **SSOT:** `docs/game_rulebook*.md` ist maßgeblich. Änderungen müssen damit übereinstimmen.
|
|
2. **Modularität:** Jedes Feature liegt in einem Modul (keine God-Classes, keine Mischzuständigkeiten).
|
|
3. **Permissions:** Jede Admin-/Write-Aktion braucht eine Permission; **deny overrides** müssen funktionieren.
|
|
4. **Keine Secrets:** Keine `.env`, keine echten Passwörter, keine API-Keys ins Repo.
|
|
5. **Default-Credentials:** Nur Platzhalter wie `change-me`/`your-strong-password` verwenden und dokumentieren, dass vor Prod geändert werden muss.
|
|
6. **Tests:** Tests müssen grün sein, bevor gemerged wird.
|
|
7. **Dokumentation:** Alle neuen Features, Funktionen und Module müssen unter `docs/wiki/` dokumentiert werden. Die Dokumentation muss aktuell, verständlich und vollständig sein.
|
|
8. **Commit-Disziplin:** Nach jedem neuen Feature oder Modul sofort committen; die Commit-Message benennt das Feature oder Modul ausdrücklich.
|
|
|
|
9. **Orchestrator:** Zerlegt Aufgaben immer in kleinstmögliche Subtasks; Code-Agent-Subtasks sind auf maximal 2000 Tokens (Kontext + Instruktionen) begrenzt.
|
|
|
|
## Ordner-Intent (Kurzfassung)
|
|
- `web/desktop` und `web/mobile`: Alles, was aus dem Webserver ausgeliefert wird.
|
|
- `docs/`: Dokumentation (SSOT liegt hier).
|
|
- `planning/`: Skizzen/Notizen, nicht für Deployment.
|
|
-
|
|
|
|
## Sprache
|
|
- Alle Agenten-Ausgaben und Kommentare sind **Deutsch**, außer der User verlangt explizit eine andere Sprache.
|
|
|
|
## Lokaler Test-Workflow (empfohlen)
|
|
- Sandbox-Worktree verwenden: `scripts/worktree-init.sh`, `scripts/worktree-up.sh`, `scripts/worktree-down.sh`, `scripts/worktree-destroy.sh`.
|
|
- Docker laeuft nur in der Sandbox; das Haupt-Repo bleibt frei von Logs/Uploads/DB-Daten.
|
|
- Optional: `scripts/worktree-sync.sh` uebernimmt uncommitted Aenderungen per Patch.
|
|
|
|
## Secrets
|
|
- Keine Secrets ins Repo. Nur Platzhalter in `.env.example` (z. B. `change-me` / `your-strong-password`) und Hinweis, dass vor Prod zu aendern ist.
|