Dokumentation
HeyDeer prüft GitHub-Pull-Requests anhand deiner Codebasis und der Standards deines Teams. Es veröffentlicht Befunde im Pull Request, meldet das Ergebnis in einem Check, den du als erforderlich festlegen kannst, und behebt auf Wunsch die Befunde, die du auswählst.
Wegweiser
- Best Practices: Setups für Teams mit und ohne Codeprüfung, die Einführung im Team und weniger Rauschen.
- Prüfungen auf GitHub: eine Prüfung lesen, Mit HeyDeer beheben, der Check HeyDeer Review, Befehle in PR-Kommentaren und Folgeprüfungen.
- Prüfungen konfigurieren: wie Einstellungen funktionieren, automatische Prüfungen und ihre Filter, Prüftiefe, Feedback-Umfang, Veröffentlichung und automatische Genehmigung.
- HeyDeer deine Codebasis beibringen: was HeyDeer liest, AGENTS.md, REVIEW.md, Repository-Prüfungen, Skills, Prüfanweisungen und Connectors.
- Arbeitsbereich und Abrechnung: Mitglieder, Einblicke, die Benachrichtigungsadresse, Credits, Tarife, automatische Aufladung und Nutzungslimits.
- Referenz: alle Einstellungen, Berechtigungen der GitHub App, Fehlerbehebung und die FAQ.
Funktioniert etwas nicht? Siehe Fehlerbehebung.
So funktioniert es
Was du im Pull Request siehst
HeyDeer veröffentlicht seine Befunde als Prüfung auf GitHub. Die meisten sind Inline-Kommentare an den betroffenen Zeilen, mit Schweregrad, einer Beschreibung des Problems und oft einem Korrekturvorschlag. Befunde zu Code außerhalb des Diffs erscheinen im Prüfkommentar. Siehe Eine Prüfung lesen.
Damit HeyDeer die von dir ausgewählten Befunde behebt, wähle in der Prüfung Mit HeyDeer beheben. HeyDeer öffnet einen separaten PR, den du prüfst und mergst; siehe Mit HeyDeer beheben.
Warum HeyDeer
- HeyDeer prüft jede Änderung unabhängig von der Person oder dem Agenten, von denen sie stammt.
- Es gleicht jeden Befund mit dem Code ab, bevor es ihn veröffentlicht.
- Es wendet die Konventionen in deiner AGENTS.md und die Anforderungen in deinen Repository-Prüfungen auf die Dateien an, die sie abdecken.
HeyDeer einrichten
Ein neuer Arbeitsbereich beginnt im kostenlosen Tarif mit 1.000 Credits im ersten Monat, danach 300 pro Monat. Der Schnellstart führt dich von der Installation der GitHub App bis zur ersten Codeprüfung.
Wähle dann das Setup, das dazu passt, wie dein Team heute mergt:
- Teams ohne Codeprüfung: Agenten committen direkt auf main, oder Pull Requests werden gemergt, sobald die CI erfolgreich durchläuft.
- Teams mit menschlichen Prüfern: Menschen prüfen jeden Pull Request, bevor er gemergt wird.