Conrad Schulz 045e2e7202 feat: add data/, history/, 3-target-group docs, pre-commit quality gate

- New repo convention: /data/<service>/ for all persistent service data (gitignored)
- New repo convention: /history/prompts/ (gitignored) + /history/summary/PROJECT_CONTEXT.md
  for agent session logging and compressed project context
- git-templates/hooks/pre-commit: quality gate checking tests + docs on every commit
- git-templates/docs/: USER.md, ADMIN.md, MAINTAINER.md templates (3 target groups)
- git-templates/history/summary/PROJECT_CONTEXT.md: agent context template
- prompts/history.prompt.md: /history prompt for logging sessions + updating summary
- copilot-bootstrap.sh: creates all new folders, .gitignore entries, installs hook
- deploy.sh + deploy.fish: deploy hooks, doc templates, history template
- docs/ADMIN.md: new admin handbook for this project
- docs/USER.md + docs/MAINTAINER.md: updated with new conventions
- git-templates/.github/copilot-instructions.md: extended DoD + new conventions
- README.md: updated structure overview + prompt table

2026-05-30 17:19:52 +00:00

3 KiB

Raw Blame History

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 (gitignored)
│   └── 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 history/summary/PROJECT_CONTEXT.md. Nach Abschluss einer Aufgabe wird dort der Projektzustand aktualisiert.

Vollständige Konversationen: history/prompts/ (gitignored, lokal)
Komprimierter Kontext: history/summary/PROJECT_CONTEXT.md (committed)

Neues Feature hinzufügen

history/summary/PROJECT_CONTEXT.md lesen – aktuellen Stand verstehen
Issue / Ticket anlegen
Branch: git checkout -b feat/<ticket>-beschreibung
Implementieren + Tests schreiben
Dokumentation in docs/USER.md oder docs/ADMIN.md aktualisieren
git commit – Quality Gate läuft automatisch (pre-commit hook)
PR erstellen + Review

Designentscheidungen

Entscheidung	Begründung
…	…

3 KiB Raw Blame History Unescape Escape