rd13_copilot_setup/git-templates/.github/copilot-instructions.md

GitHub Copilot – Project Instructions

Project

Stack

• Language:
• Framework:
• Database:
• Infrastructure:

Architecture

• Pattern (MVC / Hexagonal / Event-driven / ...):
• Key constraints:
• ADR location: docs/adr/

Project Structure Conventions

Persistent Data (/data/)

• Alle persistenten Service-Daten gehören in /data/<service-name>/ (Repo-Root)
• Nie Daten-Dateien committen – /data/ ist vollständig gitignored
• Einen Unterordner pro Service (z.B. data/postgres/, data/redis/, data/uploads/)
• Erforderliche Unterordner in docs/ADMIN.md dokumentieren

Agent History (/history/)

• Vollständige Konversationen → history/prompts/YYYY-MM-DD_beschreibung.md (committed – vollständige History bleibt erhalten)
• Komprimierter Kontext → history/summary/PROJECT_CONTEXT.md (committed, immer aktuell halten!)
• Beim Start einer neuen Session: history/summary/PROJECT_CONTEXT.md zuerst lesen
• Am Ende jeder Session: beide Dateien committen
• Copilot Chat: /history → History loggen + Summary aktualisieren

Documentation (3 Zielgruppen – alle 3 müssen existieren)

Datei	Zielgruppe	Inhalt
docs/USER.md	Endnutzer	Features, How-To, FAQ – keine technischen Details
docs/ADMIN.md	Administratoren	Deployment, Konfiguration, Monitoring, Backup
docs/MAINTAINER.md	Entwickler	Architektur, ADRs, Konventionen, Erweiterung

Regel: Jede bedeutende Änderung muss mindestens eine dieser Dateien aktualisieren. Der pre-commit Hook prüft dies automatisch.

Conventions

• Branch naming: feat/<ticket>-description, fix/<ticket>-description
• Commit format: Conventional Commits (feat|fix|chore|docs|refactor|test|ci)
• File structure:
• Naming:

Engineering Process

Before starting any task

1. Clarify requirements – user story + acceptance criteria vorhanden?
2. Impact analysis – welche bestehenden Komponenten sind betroffen?
3. Architecture check – passt die geplante Lösung zur bestehenden Architektur?
4. Test strategy – wie wird das Feature getestet?

Definition of Ready (DoR)

A task can only be started when:

• Acceptance criteria are clear and unambiguous
• Non-functional requirements defined (performance, security, scalability)
• Architectural approach agreed upon
• No unresolved external blockers

Definition of Done (DoD)

A task is only done when ALL of the following are true:

• Code implements the acceptance criteria
• Unit tests written and passing
• Integration tests (where applicable) passing
• No linter / type errors
• No secrets or credentials in code
• OWASP Top 10 reviewed
• Relevant documentation updated: docs/USER.md and/or docs/ADMIN.md and/or docs/MAINTAINER.md
• Alle 3 Zielgruppen-Dokumente vorhanden (docs/USER.md, docs/ADMIN.md, docs/MAINTAINER.md)
• Persistente Daten liegen ausschließlich in /data/<service>/ (nie woanders)
• history/summary/PROJECT_CONTEXT.md aktualisiert
• Commit message follows Conventional Commits
• No dead code, no TODOs left behind (or tracked as issues)
• pre-commit Quality Gate bestanden (oder Bypass bewusst begründet)

Testing Strategy

• Framework:
• Coverage target: ≥ 80% (critical paths: 100%)
• Test pyramid: unit > integration > e2e
• Test location: tests/ mirroring source structure

Security

• No secrets in code or config files – use environment variables
• Validate all inputs at system boundaries
• Principle of least privilege for all permissions
• Dependency vulnerabilities: check before adding new deps

Documentation Standards

• Code comments: explain WHY, not WHAT
• Public APIs: always documented
• Architecture decisions: write ADR in docs/adr/ (template: docs/adr/000-template.md)
• CHANGELOG.md: update with every release
• 3-Zielgruppen-Regel: USER.md (Endnutzer) + ADMIN.md (Ops) + MAINTAINER.md (Dev) – immer alle 3 pflegen

Non-Functional Requirements

• Response time:
• Availability:
• Data retention: