REVIEW.md
Hinweise, die nur bei der Codeprüfung zählen, gehören in REVIEW.md: was geprüft werden soll, was außen vor bleibt und wie schwer ein Problem wiegt. Andere Tools zur Codeprüfung wie Claude Code Review lesen dieselbe Datei, sodass du deine behalten kannst.
Was hineingehört
- Was in jedem Pull Request geprüft werden soll, etwa wie Datenbankabfragen eingegrenzt sind.
- Was außen vor bleiben soll, etwa Probleme, die deine CI bereits meldet. Fasse Ausschlüsse eng und nenne die Pfade, für die sie gelten.
- Wie schwer eine Art von Problem für dein Team wiegt, mit den Schweregraden von HeyDeer: Kritisch, Hoch, Mittel und Niedrig.
REVIEW.md
# Review instructions
## Always check
- Database queries in src/api/ are scoped to the caller's
workspace.
- Log lines don't include email addresses or request bodies.
## Leave alone
- Formatting and lint issues. CI enforces them.
- Code in tests/fixtures/ that breaks production rules on purpose.
## Severity
- A migration that isn't backward compatible is High.
- Naming and refactoring suggestions are Low.Coding-Konventionen gehören in AGENTS.md, damit auch Coding-Agenten sie befolgen. Eine Anforderung, die HeyDeer in jedem passenden Pull Request verifizieren muss, gehört in eine Repository-Prüfung.
Dateien im Stammverzeichnis und in Unterverzeichnissen
Lege REVIEW.md im Stammverzeichnis des Repositorys an. Ein Verzeichnis, das eigene Hinweise braucht, kann eine eigene Datei haben, etwa src/payments/REVIEW.md.
Eine REVIEW.md gilt für Änderungen in ihrem Verzeichnis und allen darunterliegenden. Eine tiefer liegende Datei ergänzt die darüberliegenden und hat bei Widersprüchen Vorrang.
| Geänderte Datei | Geltende Dateien, der Reihe nach |
|---|---|
src/api/invoices.ts | REVIEW.md |
src/payments/refund.ts | REVIEW.md, src/payments/REVIEW.md |
Was Einstellungen festlegen
REVIEW.md ändert, worauf HeyDeer achtet und wie schwer ein Problem wiegt, nicht wie HeyDeer berichtet. Dafür gibt es Einstellungen: Prüfsprache, Feedback-Umfang und Automatische Genehmigung. Um zum Beispiel weniger Befunde mit Schweregrad Niedrig zu veröffentlichen, wähle den Feedback-Umfang „Kompakt“.
REVIEW.md gilt nicht für Repository-Prüfungen: Eine passende Prüfung läuft immer, und nur die Prüfung selbst legt fest, was gegen sie verstößt.
Um generierte Dateien zu überspringen, markiere sie stattdessen in .gitattributes, damit sie gar nicht erst in die Prüfung gelangen. Siehe Generierte Dateien.
Pull Requests, die REVIEW.md bearbeiten
HeyDeer liest REVIEW.md aus dem Pull Request, sodass ein Pull Request, der sie bearbeitet, mit seiner eigenen Version geprüft wird, und HeyDeer genehmigt ihn nie automatisch. Hinweise, die vor Änderungen durch Pull Requests geschützt sein müssen, gehören in die Prüfanweisungen.
Umstieg von Claude Code Review
Deine REVIEW.md funktioniert unverändert. Diese Unterschiede bleiben:
- HeyDeer liest REVIEW.md aus dem Pull Request, Claude Code Review dagegen aus dem Basis-Branch.
- Important entspricht dem Schweregrad Mittel oder höher, Nit dem Schweregrad Niedrig.
- Eine Begrenzung der Anzahl von Nits gilt nicht. Wähle stattdessen den Feedback-Umfang „Kompakt“.
- HeyDeer folgt keinen Einbindungen wie
@review-security.md. Übernimm ihre Hinweise in REVIEW.md.