heydeer
Best Practices

Einführung im Team

Führe HeyDeer schrittweise ein, und lass es Merges erst dann blockieren, wenn dein Team seinen Ergebnissen vertraut.

Bevor du beginnst

Ein Admin des Arbeitsbereichs ändert in jeder Phase die Einstellungen; alle mit Schreibzugriff können Prüfungen anfordern. Siehe Mitglieder des Arbeitsbereichs.

Alle Tarife enthalten monatliche Credits. Ein neuer Arbeitsbereich startet im ersten Monat mit 1.000 Credits im kostenlosen Tarif. In jedem Tarif, auch im kostenlosen, kannst du Credits zum Grundpreis von $10 pro 1.000 Credits hinzufügen.

E-Mails zu Credits und Zahlungen gehen an die Adresse unter Arbeitsbereichseinstellungen → Benachrichtigungen. Verwende eine Adresse, die dein Team liest, etwa eine Teamadresse. Siehe Benachrichtigungsadresse.

Phasen

  1. Optional: Probiere HeyDeer aus, bevor dein Team es sieht. Deaktiviere unter Arbeitsbereichseinstellungen → Prüfregeln → Ergebnisse veröffentlichen die Optionen GitHub-Check veröffentlichen und Prüfkommentare im PR veröffentlichen. Fordere Prüfungen über Prüfung starten an, lies die Ergebnisse auf der Seite Prüfverlauf und aktiviere beide Optionen vor der nächsten Phase wieder.
  2. Probiere es an einigen Pull Requests aus. Wenn HeyDeer nach der Einrichtung Prüfungen anpassen anzeigt, deaktiviere Pull Requests automatisch prüfen und wähle Weiter, damit es nur auf Anfrage prüft. Kommentiere dann @heydeer review in einer Handvoll offener Pull Requests unterschiedlicher Art und vergleiche die Befunde mit denen deiner Prüfer.
  3. Schließe die erkannten Lücken. Ergänze nur, was sich bei diesen Prüfungen als nötig erwiesen hat: Coding-Konventionen in AGENTS.md, Anforderungen in Repository-Prüfungen und Prioritäten in Prüfanweisungen. Siehe Was HeyDeer liest.
  4. Aktiviere automatische Prüfungen für ein oder zwei Repositorys: Wähle sie unter Repositorys aus und dann Zeitpunkt ändern. Sobald ihre Prüfungen passen, lege den Prüfzeitpunkt des Arbeitsbereichs unter Arbeitsbereichseinstellungen → Prüfregeln → Wann prüfen fest.
  5. Wechsle zum passenden Setup für dein Team. Mach den Check HeyDeer Review erforderlich und entscheide über die automatische Genehmigung. Siehe Teams ohne Codeprüfung oder Teams mit menschlichen Prüfern.
  6. Richte die Ausgabenkontrolle ein. Aktiviere in einem kostenpflichtigen Tarif die automatische Aufladung und lege ein Nutzungslimit fest. Siehe Automatische Aufladung und Nutzungslimits.
  7. Zeig dem Team, wie es mit HeyDeer arbeitet. Teile die Befehle in PR-Kommentaren und erkläre, wie man einen Befund ablehnt.

Wenn ein Pull Request nicht wie erwartet geprüft wird, siehe Fehlerbehebung.

Wann es weitergeht

Geh zur nächsten Phase über, wenn aktuelle Prüfungen alles Folgende zeigen:

  • Dein Team reagiert auf die meisten Befunde.
  • Abgelehnte Befunde folgen keinem Muster, das du mit Prüfanweisungen oder einer Repository-Prüfung beheben könntest. Falls doch, siehe Rauschen reduzieren.
  • Prüfungen werden ohne Hinweise zur Prüfung abgeschlossen, etwa zu einer Repository-Prüfung, die nicht ausgeführt wurde.

Lies nach einigen Wochen aktuelle Prüfungen erneut. Verschiebe Hinweise dorthin, wo sie hingehören, und entferne Anweisungen und Repository-Prüfungen, die nie etwas am Ergebnis einer Prüfung ändern.