Skip to content

Coding Agent Setups

Das TreeQuest-Repository wurde von Grund auf so strukturiert, dass KI-Coding-Assistenten (wie Cursor, Google Gemini, GitHub Copilot) den Kontext des Projekts schnell erfassen und qualitativ hochwertigen, konsistenten Code generieren können.

Dafür liegen im Repository dedizierte Einstiegspunkte und Regelwerke (Rules) bereit.

1. Gemeinsamer Einstiegspunkt: AGENTS.md

Die Datei AGENTS.md im Hauptverzeichnis dient als zentraler Einstiegspunkt für alle KI-Coding-Assistenten. Sie fungiert als Inhaltsverzeichnis für den Agenten und leitet ihn zu den relevanten Kontextdokumenten weiter.

Verknüpfte Kontext-Dokumente:

Wenn ein Agent das Projekt betritt, liest er über AGENTS.md folgende Architektur- und Konventionsrichtlinien:

  1. Projektübersicht & Tech-Stack: conductor/product.md und conductor/tech-stack.md definieren die groben Leitplanken.
  2. Workflow & Commits: conductor/workflow.md diktiert den Task-Lebenszyklus und den Commit-Prozess (z.B. nach Conventional Commits).
  3. Code-Styleguides: Der Ordner conductor/code_styleguides/ enthält sprachenspezifische Formatierungsregeln für Python (Backend) und TypeScript (Frontend).
  4. Architektur: treequest-architecture.md liefert detailliertes Systemwissen (siehe auch Architektur).
  5. Entscheidungen (ADRs): docs/decisions/README.md und die verlinkten Architectural Decision Records sorgen dafür, dass die KI getroffene Architekturentscheidungen nicht unbeabsichtigt revidiert.

2. Gemini-spezifische Anweisungen: GEMINI.md

Für Entwickler, die Google Gemini (bzw. die Gemini Agenten-Integration) nutzen, gibt es die dedizierte Konfigurationsdatei GEMINI.md.

Diese Datei fasst die essenziellsten Informationen für den Gemini-Agenten zusammen, damit dieser sofort loslegen kann, ohne Dutzende Dateien scannen zu müssen. Sie enthält: - Einen High-Level Tech-Stack Überblick. - Exakte Befehle für das lokale Setup (wie Docker Compose oder lokale Python-Environments). - Klare Development Conventions (z.B. "Nutze Pydantic v2", "Strict TypeScript", "Schreibe Comments auf Englisch"). - Hinweise auf Spezialfälle, wie z.B. die explizite Nutzung von alembic upgrade heads bei verzweigten Datenbankmigrationen.

3. Der conductor/ Ordner (Projektmanagement für KIs)

Der conductor/-Ordner fungiert als das "Gehirn" für die Entwicklungsplanung und das KI-Projektmanagement:

  • Aktive Entwicklungsstränge: In conductor/tracks.md wird festgehalten, woran gerade gearbeitet wird.
  • Planung: Unter conductor/archive/<feature>/plan.md liegen detaillierte Umsetzungsschritte für anstehende Features.
  • Historie: Historischer Kontext, alte Prompts und Projekt-Evolutionen werden im Ordner conductor/archive/ abgelegt. Agenten werden angewiesen, diese Dateien nur als Lese-Referenz zu nutzen und den aktuellen Konventionen den Vorzug zu geben.

Wichtig für Agenten: Wenn sich Anweisungen widersprechen, haben die ADRs (Architectural Decision Records) immer Vorrang. Danach gelten die Dokumente im conductor/-Ordner, während der archive/-Ordner nur historischen Kontext liefert.