PR-Dokumentation
Jeder Pull Request bekommt hier eine Datei.
Dateiname
JJJJ-MM-TT-PR#<nummer>-kurze-beschreibung.md
Die Nummer ist die des Gitea-PR auf https://git.javagil.de/mi/werkbaum.
Gitea begann nach dem Umzug (D95) wieder bei 1, während die Historie schon
GitHub-PR #1 und #2 kennt; die Nummern 1 und 2 sind deshalb abgebrannt und die
Zählung setzt bei #3 auf.
Steht sie noch nicht fest, gilt PR#000 als Platzhalter — im Dateinamen wie in
den Szenario-IDs — und wird nachgezogen, sobald der PR offen ist.
Ablauf
Die Schritte rund um ein PR-Dokument stehen in docs/agentic-workflow.md, „Steps of a PR“.
Aufbau
Die ##-Abschnitte in genau dieser Reihenfolge, nicht Zutreffendes weglassen:
- Das Problem
- Nicht das Ziel
- Die Szenarien
- Die Lösung
- Offene Fragen
- Weitere Änderungen
- Vorausgesetzte PRs
- Folge-PRs
Regeln
- Deutsch (AGENTS.md), Markdown, ein Satz je Zeile, kurz halten.
- Das „Warum“ erklären, nicht nur das „Was“.
- Szenarien in Markdown-eigenem Pseudo-Gherkin mit IDs
Szenario#<pr-nummer>.<nn>, jedes mit einer Liste##### Nachgewiesen durch. - Ein PR-doc beschreibt den Stand dieses PR. Ältere PR-docs werden nicht
nachgepflegt, wenn spätere PRs das Verhalten ändern — dauerhafte Begründungen
gehören nach
docs/DECISIONS.md.