heydeer Anmelden
Best Practices

Einführung im Team

Führen Sie HeyDeer schrittweise ein, und lassen Sie es Merges erst dann blockieren, wenn Ihr Team seinen Ergebnissen vertraut.

Phasen

  1. Probieren Sie es an einigen Pull Requests aus. Ein neuer Arbeitsbereich startet mit „Nur manuell“. Kommentieren Sie @heydeer review bei einer Handvoll aktueller Pull Requests unterschiedlicher Art und vergleichen Sie die Befunde mit denen Ihrer Prüfer.
  2. Schließen Sie die erkannten Lücken. Ergänzen Sie nur, was sich bei diesen Prüfungen als nötig erwiesen hat: Konventionen, Regeln, die immer gelten müssen, und Prioritäten. Siehe Wohin welche Regel gehört.
  3. Aktivieren Sie automatische Prüfungen. Beginnen Sie mit „Einmal pro PR“ in ein oder zwei Repositorys, wechseln Sie dann zu „Bei jedem Push“ mit einem Wert für „Maximale automatische Reviews pro PR“, und legen Sie den Review-Zeitpunkt der Organisation fest. Siehe Automatische Reviews.
  4. Veröffentlichen Sie den Check, ohne Merges davon abhängig zu machen. Standardmäßig ist der Check HeyDeer Review auch dann erfolgreich, wenn die Prüfung Probleme findet. Belassen Sie es dabei, während sich das Team an die Befunde gewöhnt.
  5. Verlangen Sie den Check, sobald das Team ihm vertraut. Machen Sie HeyDeer Review in Ihren GitHub-Branch-Regeln zu einem erforderlichen Check und aktivieren Sie dann „Prüfung bei gefundenen Problemen fehlschlagen lassen“. Eine Revision, die nicht automatisch geprüft wird, wartet dann auf @heydeer review. Siehe Der Check HeyDeer Review.
  6. Entscheiden Sie über die automatische Genehmigung. Sie ist standardmäßig deaktiviert. Wenn Sie sie aktivieren, beginnen Sie mit „Nur einfache Änderungen“ und lassen Sie veraltete Genehmigungen in Ihren Branch-Regeln verwerfen. Siehe Automatische Genehmigung.
  7. Richten Sie Benachrichtigungen und Ausgabenkontrolle ein. Hinterlegen Sie eine E-Mail-Adresse für den Arbeitsbereich für Hinweise zu Credits und Testphase, und aktivieren Sie die automatische Aufladung mit einem Nutzungslimit. Siehe Benachrichtigungen und Automatische Aufladung und Nutzungslimits.
  8. Zeigen Sie dem Team, wie es mit HeyDeer arbeitet. Teilen Sie die Befehle in PR-Kommentaren, erklären Sie, wie man einen Befund per Antwort ablehnt, und wie man gut prüfbare Pull Requests schreibt.

Checkliste

  • Einige echte Pull Requests mit „Nur manuell“ geprüft
  • AGENTS.md, Repository-Prüfungen oder Anweisungen für das ergänzt, was diese Prüfungen übersehen haben
  • Generierte Dateien markiert und Bot-Pull-Requests herausgefiltert
  • „Einmal pro PR“ und dann „Bei jedem Push“ mit Prüflimit aktiviert
  • Den Check HeyDeer Review veröffentlicht, ohne ihn bei Problemen fehlschlagen zu lassen
  • Entschieden, ob der Check verlangt werden und bei Problemen fehlschlagen soll
  • Über die automatische Genehmigung entschieden
  • Benachrichtigungsadresse, automatische Aufladung und Nutzungslimit eingerichtet
  • Die Befehle geteilt und erklärt, wie man einen Befund ablehnt

Lesen Sie nach einigen Wochen aktuelle Prüfungen erneut, verschieben Sie falsch platzierte Regeln und entfernen Sie Regeln, die nichts bewirken.