heydeer

Häufige Fragen

Alles, was Teams vor und nach dem Start wissen wollen: Einrichtung, Prüfungen, Behebungen, Preise und Sicherheit.

Erste Schritte

Wie richte ich HeyDeer ein?

Verbinde GitHub, wähle Repositorys aus und fordere dann eine Prüfung an:

  • Melde dich mit GitHub an und wähle unter Wähle, wo deine Repositorys liegen dein persönliches Konto oder deine Organisation. Fehlt es in der Liste, wähle Auf GitHub installieren und wähle es dort aus.
  • Wähle auf GitHub Only select repositories, markiere die Repositorys, die geprüft werden sollen, und bestätige. In einer Organisation bittet GitHub einen Inhaber um Genehmigung, sofern du nicht selbst einer bist.
  • Entscheide, ob HeyDeer von sich aus prüft: Lass Pull Requests automatisch prüfen eingeschaltet, damit jeder Push geprüft wird, bis zu 5-mal pro Pull Request, oder schalte es aus, damit nur auf Anfrage geprüft wird.
  • Kommentiere @heydeer review in einem offenen Pull Request.

Du brauchst Schreibzugriff auf das Repository. Ein neuer Arbeitsbereich startet im kostenlosen Tarif ohne Kreditkarte, und die Befunde erscheinen als Prüfkommentare im Pull Request.

Mehr erfahren: Schnellstart
Funktioniert HeyDeer mit GitLab oder Bitbucket?
HeyDeer arbeitet mit GitHub, in öffentlichen und privaten Repositorys, für Organisationen und persönliche Konten. Es wird als GitHub App installiert, und du legst fest, welche Repositorys es lesen und prüfen darf. So bleibt sein Zugriff auf den Code beschränkt, den du prüfen lassen willst. Jeder Arbeitsbereich gehört zu einem GitHub-Konto; um ein weiteres zu verbinden, wähle im Arbeitsbereichsmenü Arbeitsbereich hinzufügen.
Mehr erfahren: GitHub App und Berechtigungen
Muss ich vor der ersten Prüfung etwas konfigurieren?

Du kannst direkt nach dem Verbinden eine Prüfung anfordern. HeyDeer liest die Änderungen des Pull Requests im Kontext des gesamten Repositorys, zusammen mit Titel, Beschreibung und Diskussion des PRs, und jede Prüfung sucht von Anfang an nach Bugs und Sicherheitsproblemen.

Wenn deine ersten Prüfungen eine Lücke zeigen, ergänze Hinweise dort, wo sie hingehören:

  • AGENTS.md für die Funktionsweise deines Codes und die Konventionen, denen er folgt; auch Coding-Agents halten sich daran.
  • REVIEW.md dafür, worauf Prüfungen achten sollen, was sie ignorieren sollen und wie schwer ein Problem wiegt.
  • Eine Repository-Prüfung für eine Anforderung, die HeyDeer in jedem Pull Request verifizieren muss, der bestimmte Dateien ändert.
  • Prüfanweisungen für Hinweise, die ein Pull Request nicht ändern darf oder die für alle Repositorys gelten.
Mehr erfahren: Was HeyDeer liest
Wann beginnt HeyDeer, Pull Requests zu prüfen?

Sobald jemand darum bittet: Kommentiere @heydeer review in einem Pull Request, wähle Prüfung starten auf der Seite Prüfverlauf oder wähle Re-run beim Check HeyDeer Review. Ein neuer Arbeitsbereich startet mit Nur manuell, und direkt nach der Einrichtung fragt HeyDeer, ob automatisch geprüft werden soll.

Ein Admin des Arbeitsbereichs kann den Zeitpunkt jederzeit unter Arbeitsbereichseinstellungen → Prüfregeln → Wann prüfen ändern:

  • Einmal pro PR prüft einen passenden Pull Request, bis eine Prüfung erfolgreich ist.
  • Bei jedem Push prüft, sobald der Pull Request zum ersten Mal deinen Filtern entspricht, und danach nach jedem Push, der Commits hinzufügt, standardmäßig bis zu 5-mal.

Automatische Prüfungen überspringen standardmäßig Entwürfe, Forks und Abhängigkeitsupdates.

Mehr erfahren: Automatische Prüfungen
Warum zeigt HeyDeer an, dass es auf die Genehmigung eines GitHub-Inhabers wartet?
In einer GitHub-Organisation kann nur ein Inhaber die HeyDeer GitHub App installieren. Verbindet jemand anderes sie, schickt GitHub den Inhabern deshalb eine Anfrage, und HeyDeer zeigt Warten auf die Genehmigung eines GitHub-Inhabers. Admins des Arbeitsbereichs können die Wartezeit nutzen, um Einstellungen vorzunehmen, damit Prüfungen von Anfang an so laufen, wie du es willst. Sobald ein Inhaber auf GitHub zustimmt, verbindet sich der Arbeitsbereich von selbst, und HeyDeer schreibt eine E-Mail an die Benachrichtigungsadresse des Arbeitsbereichs.
Mehr erfahren: GitHub App und Berechtigungen
Wie füge ich weitere Repositorys hinzu?
Wähle Repositorys hinzufügen auf der Seite Repositorys oder GitHub-Zugriff verwalten unter Arbeitsbereichseinstellungen → GitHub-Verbindung und wähle dann auf GitHub die Repositorys aus. Nur ein Inhaber des GitHub-Kontos kann die Änderung speichern; alle anderen sehen Team fragen mit einer Anfrage, die sie kopieren und an einen Inhaber schicken können. Hinzugefügte Repositorys folgen den Standardeinstellungen des Arbeitsbereichs in den Prüfregeln und werden deshalb sofort wie die übrigen geprüft. Damit auch später erstellte Repositorys dazugehören, wähle auf GitHub All repositories.
Mehr erfahren: GitHub App und Berechtigungen
Wie führen wir HeyDeer im Team ein?

Führe es schrittweise ein und lass HeyDeer über Merges entscheiden, sobald dein Team seinen Ergebnissen vertraut:

  • Probiere es an ein paar Pull Requests aus: Kommentiere bei ausgeschalteten automatischen Prüfungen @heydeer review in einer Handvoll unterschiedlicher PRs und vergleiche die Befunde mit denen deiner Reviewer.
  • Schließe die Lücken, die diese Prüfungen zeigen: Konventionen in AGENTS.md, Anforderungen in Repository-Prüfungen, Prioritäten in Prüfanweisungen.
  • Schalte automatische Prüfungen für ein oder zwei Repositorys ein (wähle sie unter Repositorys aus, dann Zeitpunkt ändern) und danach für den ganzen Arbeitsbereich.
  • Mach den Check HeyDeer Review erforderlich, entscheide über die automatische Genehmigung und richte in einem kostenpflichtigen Tarif die automatische Aufladung und ein Nutzungslimit ein.

Geh zur nächsten Stufe über, wenn dein Team die meisten Befunde umsetzt und Prüfungen ohne Hinweise zur Prüfung abschließen. Admins des Arbeitsbereichs ändern die Einstellungen; alle mit Schreibzugriff können Prüfungen anfordern.

Mehr erfahren: Einführung im Team
Kann ich HeyDeer ausprobieren, bevor mein Team es sieht?
Ja. Schalte unter Arbeitsbereichseinstellungen → Prüfregeln → Ergebnisse veröffentlichen die Optionen GitHub-Check veröffentlichen und Prüfkommentare im PR veröffentlichen aus. Fordere dann Prüfungen mit Prüfung starten auf der Seite Prüfverlauf an und lies die Ergebnisse dort; sie erscheinen nur in HeyDeer. Die Prüfungen laufen trotzdem und verbrauchen Credits. Schalte beide Optionen wieder ein, wenn du die Prüfungen mit deinem Team teilen willst.
Mehr erfahren: Ergebnisse veröffentlichen
Woran erkenne ich, dass HeyDeer meine Anfrage angenommen hat?
HeyDeer setzt 👀 unter deinen Kommentar, wenn es die Anfrage annimmt, entfernt es, wenn die Prüfung fertig ist, und veröffentlicht die Prüfung im Pull Request. In der Zwischenzeit zeigt der Check HeyDeer Review den Fortschritt der Prüfung. Kann HeyDeer die Prüfung nicht ausführen, oder schlägt sie fehl oder wird abgebrochen, antwortet HeyDeer auf deinen Kommentar. Bekommt ein Kommentar kein 👀, wurde er nicht als Befehl erkannt: Poste ihn als reinen Text in einem neuen Kommentar, nicht in Code, einem Zitat oder einer Bearbeitung.
Mehr erfahren: Befehle in PR-Kommentaren
Wo finde ich die Ergebnisse einer Prüfung?
Im Pull Request. HeyDeer veröffentlicht seine Befunde als GitHub-Review, mit einem Inline-Kommentar an den Zeilen, um die es bei jedem Befund geht. Ein Befund zu Code außerhalb des Diffs, etwa zu einem unveränderten Aufrufer, den die Änderung kaputt macht, erscheint im Text der Prüfung unter Weitere Befunde. Der Check HeyDeer Review meldet das Ergebnis, und sein Link Details öffnet den vollständigen Bericht in HeyDeer, wo die Seite Prüfverlauf jede Prüfung auflistet. Die Schaltfläche Rundgang öffnet einen Leitfaden zur Änderung, der zusammengehörige Bearbeitungen gruppiert und die wichtigen hervorhebt, für alle, die den Pull Request als Nächstes lesen.
Mehr erfahren: Eine Prüfung lesen
Prüft HeyDeer Pull Requests, die Coding-Agents öffnen?
Ja. Pull Requests von Coding-Agents und anderen Bots werden wie alle anderen geprüft. HeyDeer prüft jeden davon unabhängig von dem Agent, der ihn geschrieben hat. Das ist wichtig, weil ein Agent seine eigenen Fehler leicht übersieht, und bei späteren Pushes prüft HeyDeer seine früheren Bedenken erneut. Die standardmäßigen Filter für automatische Prüfungen überspringen nur Entwürfe, Forks und Abhängigkeitsupdates von Bots wie Dependabot und Renovate. Damit Agent-PRs gemergt werden, sobald HeyDeer sie genehmigt, folge der Einrichtung für Teams ohne Codeprüfung.
Mehr erfahren: Teams ohne Codeprüfung

Noch Fragen?

Chatte mit dem Team, das HeyDeer entwickelt, oder schreib uns eine E-Mail.