Prüfanweisungen
Prüfanweisungen sagen HeyDeer, was Priorität hat, was außen vor bleiben soll und wie Feedback formuliert wird. Sie werden in HeyDeer gespeichert, daher kann ein Pull Request sie nicht ändern.
Anweisungen hinzufügen
- Öffne Arbeitsbereichseinstellungen → Prüfanweisungen. Für ein einzelnes Repository öffne Repositorys → (ein Repository) → Prüfanweisungen.
- Schreibe einfachen Text oder Markdown mit bis zu 12.000 Zeichen.
- Wähle Arbeitsbereichsanweisungen speichern oder Repository-Anweisungen speichern.
- Arbeitsbereichsanweisungen gelten für jedes Repository. Repository-Anweisungen werden ihnen hinzugefügt und haben bei Widersprüchen Vorrang.
- Auf der Seite eines Repositorys zeigt Kombinierte Anweisungen ansehen beide in ihrer Reihenfolge.
- Änderungen gelten für Prüfungen, die nach dem Speichern angefordert werden.
- Nur Admins des Arbeitsbereichs können Anweisungen bearbeiten.
- Trage keine Passwörter, Tokens oder andere Geheimnisse in Anweisungen ein.
Was in Anweisungen gehört
Anweisungen enthalten Hinweise, die nur bei der Prüfung durch HeyDeer zählen: was Priorität hat, was außen vor bleiben soll, welche Begriffe dein Team verwendet und wie Feedback formuliert wird.
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.
Um solche Hinweise im Repository neben dem Code abzulegen, um den es geht, nutze REVIEW.md. Ein Pull Request kann REVIEW.md ändern, daher gehört in die Anweisungen, was er nicht ändern darf.
Anweisungen haben Vorrang vor REVIEW.md, AGENTS.md und Skills, können aber nicht verhindern, dass eine Repository-Prüfung ausgeführt wird. Siehe Wenn sich Hinweise widersprechen.
Wirksame Anweisungen schreiben
Lass HeyDeer einige Pull Requests prüfen, bevor du etwas schreibst. Füge eine Anweisung hinzu, wenn etwas wiederholt übersehen wird oder ein unerwünschter Kommentar immer wieder auftaucht, jeweils nur wenige auf einmal, und lies die nächsten Prüfungen, um die Wirkung zu sehen.
- Gruppiere Anweisungen unter wenigen Überschriften, etwa „Priorities“, „Leave alone“, „Terms“ und „Feedback“.
- Schreibe eine Anweisung pro Aufzählungspunkt, und nenne die Pfade, Funktionen und Bibliotheken, um die es geht.
- Nenne die Begründung, wenn sie nicht offensichtlich ist.
- Fasse Ausschlüsse eng: „Keine Kommentare zu Dateien in scripts/one-off/“, nicht „Keine Kommentare zu Skripten“, was auch echte Fehler verbirgt.
- Lege über Einstellungen fest, wie HeyDeer berichtet: Prüfsprache, Feedback-Umfang und Automatische Genehmigung.
## Priorities
- Code under src/payments/ is high risk. Look hardest at retries,
refunds and anything that could charge a customer twice.
## Leave alone
- Files under scripts/one-off/. They run once by hand and are deleted.
- Formatting. The formatter runs in CI.
## Terms
- A "workspace" is a customer account, not a folder on disk.
## Feedback
- Name the input that triggers a bug, and suggest the smallest fix.Wenn eine Anweisung ignoriert zu werden scheint, siehe Fehlerbehebung.