33 lines
1.7 KiB
Markdown
33 lines
1.7 KiB
Markdown
# AGENTS.md – Steuerzentrale für KI-Coding-Agenten
|
||
|
||
Dieses Dokument enthält strikte Anweisungen für KI-Assistenten und Coder-Agenten (z. B. Continue, Copilot, lokale LLMs), die an diesem Repository arbeiten.
|
||
|
||
---
|
||
|
||
## 1. Code-Style, Header- & Dokumentationspflicht
|
||
|
||
Jede neu erstellte oder modifizierte Quelltext-Datei (`.py`, `.j2`, `.html`, `.js`, `.css`) **MUSS** den standardisierten Dateikopf sowie entsprechende In-Code-Dokumentation tragen.
|
||
|
||
* **Dateikopf-Standard:** Autor `Björn Runden <br@runden.net>`.
|
||
* **PyDoc & Docstrings:** Jede Klasse, Funktion und Methode in Python-Dateien muss PyDoc-Docstrings enthalten.
|
||
* **Jinja2 / HTML-Kommentare:** Logikführende Jinja2-Templates (Schleifen, Makros, Modale, Bedingungen) müssen mit Kommentar-Blöcken versehen werden.
|
||
* **Details & Beispiele:** Read [`docs/coding-standards.md`](./docs/coding-standards.md).
|
||
|
||
---
|
||
|
||
## 2. Architektur-Vorgaben
|
||
|
||
* **Flask Blueprints:** Der Code MUSS modular über Flask-Blueprints strukturiert werden (keine monolithische `app.py`).
|
||
* **Datenbank:** Zugriff NIEMALS direkt über Roh-SQL oder Datenbank-CLIs, sondern AUSSCHLIESSLICH über **Flask-SQLAlchemy**.
|
||
* **Migrationen:** Schema-Änderungen müssen über **Flask-Migrate** (`flask db migrate`) abgebildet werden.
|
||
|
||
---
|
||
|
||
## 3. Regelwerke & Dokumente
|
||
|
||
Bitte lies vor der Bearbeitung spezifischer Module die folgenden Dokumente im Repository:
|
||
|
||
* **Header & PyDoc Standards:** Read [`docs/coding-standards.md`](./docs/coding-standards.md)
|
||
* **System-Architektur & DB:** Read [`ARCHITEKTUR.md`](./ARCHITEKTUR.md)
|
||
* **CI/CD & Deployment:** Read [`docs/deployment.md`](./docs/deployment.md)
|
||
* **Dev-Environment & Mocks:** Read [`docs/dev-guide.md`](./docs/dev-guide.md) |