Best Practices
Wohin welche Regel gehört
Wählen Sie den Ort für eine Regel danach, wofür sie gedacht ist und wer sie ändern können soll.
Einen Ort wählen
| Was Sie HeyDeer mitteilen möchten | Ablegen in | Wo HeyDeer es liest |
|---|---|---|
| Teamkonventionen und Projektkontext: Struktur, Benennung, welche Hilfsfunktionen zu verwenden sind | AGENTS.md | Im Pull Request. Eine verschachtelte Datei gilt für ihr Verzeichnis. |
| Eine Regel, die jeder Pull Request erfüllen muss, der bestimmte Dateien ändert | .agents/checks/ | Der Basis-Branch |
| Eine Methode oder Fachwissen, das mehrere Prüfungen gemeinsam nutzen | .agents/skills/ | Im Pull Request |
| Prüfprioritäten, was unkommentiert bleiben soll, und der Ton für jedes Repository | Organisationsanweisungen | Organisationseinstellungen → Prüfanweisungen |
| Dasselbe für ein einzelnes Repository | Repository-Anweisungen | Repositorys → (ein Repository) → Prüfanweisungen |
| Kontext außerhalb des Repositorys, etwa Tickets oder interne Dokumentation | MCP-Server | Organisationseinstellungen → MCP-Server oder die MCP-Server eines Repositorys |
| Welche Pull Requests automatisch geprüft werden | Filter für automatische Reviews | Prüfregeln |
| Wie viele Befunde veröffentlicht werden | Feedback-Umfang | Prüfregeln |
| Die Sprache, in der HeyDeer schreibt | Sprache der Prüfung | Prüfregeln |
Prüfanweisungen haben bei Widersprüchen Vorrang vor AGENTS.md.
Basis-Branch oder Pull Request
Repository-Prüfungen stammen aus dem Basis-Branch, sodass ein Pull Request keine Prüfung abschwächen kann, gegen die seine eigenen Änderungen verstoßen würden. Eine neue Prüfung gilt für Pull Requests, die nach ihrem Merge geprüft werden.
AGENTS.md und Skills stammen aus dem Pull Request, sodass sie immer zum geprüften Code passen, und jeder, der einen Pull Request öffnet, kann sie bearbeiten. Regeln, die unabhängig vom Inhalt eines Pull Requests gelten müssen, gehören in eine Repository-Prüfung oder in Prüfanweisungen.