Konvention geaendert: history/ -> docs/history/ (prompts + summary/PROJECT_CONTEXT.md). Harter Cutover im pre-commit Hook (Check 4 + Check 6 erwarten docs/history/). Bestehende Repos werden beim naechsten 'git copilot-update' automatisch per git mv migriert (Fallback mv; bei Konflikt Warnung statt Abbruch). Angepasst: pre-commit Hook, alle 6 Skripte + selftest, beide copilot-instructions.md, settings.json Session-Protokoll, history.prompt.md, README, USER/ADMIN/MAINTAINER (+ ADMIN Migrationsabschnitt). git-templates/history -> git-templates/docs/history (git mv). Validiert: shellcheck clean, fish -n clean, selftest PASS, Migrationstest PASS (sh+fish+both-present).
3 KiB
3 KiB
Maintainer-Handbuch – [PROJEKT_NAME]
Zielgruppe: Entwickler & Maintainer – Menschen, die den Code verstehen, erweitern oder reviewen. Voraussetzung: Entwicklungserfahrung mit dem eingesetzten Stack.
Architektur
┌──────────────────────────────────────────────────────────┐
│ TODO: Architektur-Diagramm (ASCII oder Mermaid) │
└──────────────────────────────────────────────────────────┘
Wichtige Komponenten:
| Komponente | Verantwortlichkeit | Ort |
|---|---|---|
| … | … | src/… |
Projektstruktur
[PROJEKT_NAME]/
├── data/ ← Persistente Daten (gitignored)
│ └── <service>/ ← Ein Unterordner pro Service
├── docs/
│ ├── USER.md ← Endnutzer-Dokumentation
│ ├── ADMIN.md ← Administrator-Dokumentation
│ ├── MAINTAINER.md ← Dieses Dokument
│ └── history/
│ ├── prompts/ ← Vollständige Agent-Konversationen (committed)
│ └── summary/
│ └── PROJECT_CONTEXT.md ← Aktueller Projektzustand für Agent-Kontext
└── … ← Source Code
Entwicklungsumgebung aufsetzen
git clone <repo>
cd <repo>
# Dependencies installieren
# Dev-Server starten
Architekturentscheidungen (ADRs)
ADR-Dateien liegen unter docs/adr/. Format: NNN-titel.md.
| Nr. | Titel | Status | Datum |
|---|---|---|---|
| 000 | Template | accepted | … |
Coding-Konventionen
- Branches:
feat/<ticket>-beschreibung,fix/<ticket>-beschreibung - Commits: Conventional Commits (
feat|fix|chore|docs|refactor|test|ci) - Tests:
tests/spiegelt Source-Struktur, ≥ 80% Coverage - Linting: …
Agent-Kontext & History
Der Agent liest beim Start immer docs/history/summary/PROJECT_CONTEXT.md.
Nach Abschluss einer Aufgabe wird dort der Projektzustand aktualisiert.
- Vollständige Konversationen:
docs/history/prompts/(committed – History bleibt vollständig erhalten) - Komprimierter Kontext:
docs/history/summary/PROJECT_CONTEXT.md(committed)
Neues Feature hinzufügen
docs/history/summary/PROJECT_CONTEXT.mdlesen – aktuellen Stand verstehen- Issue / Ticket anlegen
- Branch:
git checkout -b feat/<ticket>-beschreibung - Implementieren + Tests schreiben
- Dokumentation in
docs/USER.mdoderdocs/ADMIN.mdaktualisieren git commit– Quality Gate läuft automatisch (pre-commit hook)- PR erstellen + Review
Designentscheidungen
| Entscheidung | Begründung |
|---|---|
| … | … |