docs: AGENTS.md - TL;DR-Box, Datenschema, Commit-Tabelle raus
- TL;DR-Block vor den Regeln: 5 Kernpunkte im Telegrammstil, damit die wichtigsten Anweisungen auch durchdringen, wenn nur die ersten ~20 Zeilen scharf gelesen werden. - Datenschema von templates.json in Abschnitt 2 ergaenzt (Felder + erlaubte type-Werte: system/user/custom). Zielt auf Bugtyp 'toter Filter-Link Kategorien'. - Abschnitt 'Historie signifikanter Aenderungen' samt Commit-Tabelle gestrichen - git log ist die Quelle der Wahrheit, die Tabelle veraltete sowieso sofort. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
parent
1e2072c4fe
commit
7b471abbf0
1 changed files with 22 additions and 26 deletions
48
AGENTS.md
48
AGENTS.md
|
|
@ -2,11 +2,17 @@
|
|||
|
||||
## Zweck dieses Dokuments
|
||||
|
||||
Diese Datei richtet sich an **Coding-Agenten (Claude, Codex u.ä.), die in diesem Repository arbeiten**. Sie definiert:
|
||||
Diese Datei richtet sich an **Coding-Agenten (Claude, Codex u.ä.), die in diesem Repository arbeiten**. Sie definiert Verhaltensregeln (Abschnitt 1) und kurze Projekt-Orientierung (Abschnitt 2).
|
||||
|
||||
1. **Verhaltensregeln**, an die sich Agenten halten müssen,
|
||||
2. **kurze Projekt-Orientierung** (Einstieg, Pfade, Ports),
|
||||
3. die **Historie signifikanter Änderungen**, soweit sie dokumentationswürdig sind.
|
||||
## TL;DR
|
||||
|
||||
1. Erst lesen (Zeilen der Zielstelle nennen), dann ändern.
|
||||
2. Erst ausführen, dann berichten. Prosa ohne Tool-Call ≠ Ausführung.
|
||||
3. UI-/Server-Änderung → Server starten + `curl` → Ergebnis zitieren.
|
||||
4. Nach Refactor: `grep -c <name>` = 1. Sonst nicht fertig.
|
||||
5. Doku beschreibt Code, nicht die Arbeit am Code.
|
||||
|
||||
Details in den Regeln R1–R7 unten.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -77,6 +83,16 @@ python3 scripts/validate.py # validiert Template-Struktur
|
|||
| `docs/` | Weitere technische Dokumentation |
|
||||
| `history/CHANGELOG.md` | Änderungs-Chronik |
|
||||
|
||||
### Datenschema `templates.json` und Template-Einträge
|
||||
|
||||
`web/templates.json` ist eine **Liste** von Einträgen. Schema jedes Eintrags:
|
||||
|
||||
```json
|
||||
{ "path": "…", "type": "…", "name": "…", "description": "…", "version": "…", "tags": [], "format": "md|json" }
|
||||
```
|
||||
|
||||
Gültige Werte von `type`: **`system`**, **`user`**, **`custom`**. Andere Werte sind tote Pfade — prüfe das, bevor du UI-Elemente oder Filter auf `type` vergleichst (siehe R5).
|
||||
|
||||
### Endpunkte
|
||||
|
||||
| URL | Status | Beschreibung |
|
||||
|
|
@ -101,27 +117,7 @@ Alle anderen `/templates/...`-Pfade mappen auf `<ROOT>/templates/...` (die eigen
|
|||
|
||||
---
|
||||
|
||||
## 4. Historie signifikanter Änderungen
|
||||
|
||||
Autoritative Quelle bleibt `git log`. Diese Tabelle wird nur für Meilensteine gepflegt, nicht für jeden Commit.
|
||||
|
||||
| Datum | Commit | Kurzbeschreibung |
|
||||
|-------------|-----------|---------------------------------------------------------------------|
|
||||
| 2026-04-24 | `97fa30b` | fix: WCAG-Kontrast für alle Input-/Textarea-Elemente im JSON-Edit-Modal |
|
||||
| 2026-04-24 | `18cc40e` | feat: JSON-Edit-Modal nach Schlüssel aufgeteilt + WCAG-Kontrast |
|
||||
| 2026-04-24 | `ee1b8f7` | fix: JSON-Editor unterstützt Arrays und Objekte via Textarea |
|
||||
| 2026-04-24 | `4d9bc9d` | docs: Klarstellung zur tatsächlichen Tool-Ausführung |
|
||||
| 2026-04-24 | `581b728` | docs: Commit-Dokumentation in AGENTS.md ergänzt |
|
||||
| 2026-04-24 | `83117d0` | feat: Editier-Button in Template-Karten + PUT-Endpoint in `serve.py`|
|
||||
| 2026-04-24 | `8e01dd7` | chore: `templates.json` aktualisiert |
|
||||
| 2026-04-24 | `bd7203b` | docs: Verifikations- und Evidenzabschnitt |
|
||||
| 2026-04-24 | `7a774bb` | feat: Port 8081, Template-Pfade korrigiert, `brainstorming.md` |
|
||||
| 2026-04-24 | `cbd48df` | docs: `docs/INDEX.md` angelegt |
|
||||
| 2026-04-24 | `d788c27` | docs: AGENTS.md mit Dokumentationsverlauf |
|
||||
|
||||
---
|
||||
|
||||
## 5. Geplant / TODO
|
||||
## 4. Geplant / TODO
|
||||
|
||||
Noch nicht umgesetzt — bitte nicht als vorhanden dokumentieren, bevor es wirklich existiert:
|
||||
|
||||
|
|
@ -134,4 +130,4 @@ Noch nicht umgesetzt — bitte nicht als vorhanden dokumentieren, bevor es wirkl
|
|||
|
||||
---
|
||||
|
||||
*Letzte Aktualisierung: 2026-04-24*
|
||||
*Historie: `git log --oneline`. Letzte Aktualisierung: 2026-04-24.*
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue