heydeer
Kostenlos starten
Loslegen

Schnellstart

Verbinde HeyDeer mit GitHub und lass einen deiner Pull Requests prüfen.

Bevor du beginnst

  • Ein GitHub-Konto mit Schreibzugriff auf das Repository, das geprüft werden soll.
  • Ein offener Pull Request in diesem Repository.
  • Bei einer Organisation: ein Inhaber, der die HeyDeer GitHub App installieren oder deine Anfrage genehmigen kann.

Ein neuer Arbeitsbereich beginnt im kostenlosen Tarif. Der erste Monat beginnt mit der Erstellung und enthält 1.000 Credits; danach sind es monatlich 300. Der kostenlose Tarif führt in jedem Repository 1 Prüfung gleichzeitig aus und erfordert keine Kreditkarte. Sind die Credits aufgebraucht, füge Credits hinzu, warte auf die nächste monatliche Gutschrift oder wähle einen kostenpflichtigen Tarif. Siehe Tarife und zusätzliche Credits.

1. Anmelden und Konto auswählen

Melde dich mit GitHub an. Wähle unter Verbinde deine Repositorys dein persönliches Konto oder deine Organisation. Ist es nicht aufgeführt, wähle Auf GitHub installieren oder Auf einem anderen Konto installieren und wähle es dort aus.

2. Repositorys hinzufügen

Wenn HeyDeer nach Repositorys fragt, wähle Repositorys hinzufügen. Wähle auf GitHub Only select repositories, wähle die zu prüfenden Repositorys aus und bestätige. Wenn HeyDeer bereits darauf zugreifen kann, überspringe diesen Schritt.

In einer Organisation bittet GitHub einen Inhaber um Genehmigung, sofern du nicht selbst einer bist. Siehe GitHub App und Berechtigungen oder, wenn ein Konto oder Repository fehlt, Fehlerbehebung.

Sobald HeyDeer auf deine Repositorys zugreifen kann, prüft es jeden Push, bis zu 5-mal pro Pull Request, und zeigt Prüfungen anpassen an. Dort kannst du einen anderen Prüfzeitpunkt oder eine andere Prüftiefe wählen oder Pull Requests automatisch prüfen deaktivieren, damit HeyDeer nur auf Anfrage prüft. Du kannst das jederzeit ändern; siehe Automatische Prüfungen.

3. Eine Prüfung anfordern

Kommentiere @heydeer review im Pull Request. Du kannst auch eine Prüfung in HeyDeer starten.

alexhat kommentiert
@heydeer review
HeyDeer reagiert mit 👀 auf deinen Kommentar, sobald es die Anfrage annimmt, und veröffentlicht die Prüfung, sobald sie fertig ist.

Kein 👀 oder keine Antwort? Siehe Fehlerbehebung.

4. Die Ergebnisse auf GitHub lesen

HeyDeer veröffentlicht seine Befunde als Prüfkommentare und meldet das Ergebnis im Check HeyDeer Review. Der Link Details des Checks öffnet den vollständigen Bericht in HeyDeer. Siehe Eine Prüfung lesen.

Alle Checks bestanden
HeyDeer Review — Prüfung mit Befunden abgeschlossen
CI / test — Erfolgreich
Standardmäßig besteht der Check auch dann, wenn die Prüfung Befunde enthält. Du kannst später festlegen, dass er das Mergen blockiert.

Damit HeyDeer die von dir ausgewählten Befunde behebt, wähle im Prüfkommentar Mit HeyDeer beheben. HeyDeer öffnet einen separaten PR, den du prüfst und mergst; siehe Mit HeyDeer beheben.

Nächste Schritte

  • Lege fest, wann HeyDeer prüft. Wenn automatische Prüfungen noch deaktiviert sind, kann ein Admin des Arbeitsbereichs unter Arbeitsbereichseinstellungen → Prüfregeln → Wann prüfen die Option Einmal pro PR oder Bei jedem Push wählen; siehe Automatische Prüfungen.
  • Wähle ein Setup für dein Team: Teams ohne Codeprüfung oder Teams mit menschlichen Prüfern.
  • Bring HeyDeer deine Codebasis bei: Konventionen in AGENTS.md, Prüfungshinweise in REVIEW.md und Anforderungen, die HeyDeer verifizieren muss, als Repository-Prüfungen. Siehe Was HeyDeer liest.