heydeer
Best Practices

Teams mit menschlichen Prüfern

Nutze dieses Setup, wenn Menschen jeden Pull Request prüfen, bevor er gemergt wird. HeyDeer prüft zuerst die Details, damit sich deine Prüfer auf Design- und Produktentscheidungen konzentrieren können.

Empfohlenes Setup

Ein Pull Request wird geöffnet
HeyDeer prüft die Details
Der Autor behebt die Befunde
Ein Prüfer bewertet das Design und mergt
  1. Wähle unter Arbeitsbereichseinstellungen → Prüfregeln → Wann prüfen die Option Bei jedem Push. Siehe Automatische Prüfungen.
  2. Aktiviere unter Ergebnisse veröffentlichen die Option Check bei gefundenen Problemen fehlschlagen lassen. Siehe Der Check HeyDeer Review.
  3. Mach in den GitHub-Branch-Regeln für main den Check HeyDeer Review erforderlich. Ein Pull Request wird dann erst gemergt, nachdem HeyDeer seinen neuesten Commit geprüft hat und seine Befunde und früheren Bedenken behoben oder abgelehnt sind.
  4. Bitte die Prüfer, einen Pull Request erst zu lesen, wenn sein Check HeyDeer Review besteht. Sie können sich dann auf Design, Produktverhalten und die Fragen konzentrieren, die HeyDeer unter Klärung erforderlich aufführt.
Einige Checks waren nicht erfolgreich
HeyDeer Review — Die Prüfung hat Probleme gefunden, die bearbeitet werden müssen
CI / test — Erfolgreich
Mergen ist blockiert
Ist der Check erforderlich, kann ein Pull Request erst gemergt werden, wenn seine Befunde behoben oder abgelehnt sind.

Ein Commit, den HeyDeer nicht automatisch prüft, etwa sobald der Pull Request die Höchstzahl automatischer Prüfungen pro PR erreicht, blockiert das Mergen ebenfalls, bis jemand eine Prüfung anfordert. Siehe Fehlerbehebung.

Optional: Routineänderungen automatisch genehmigen

Schalte die automatische Genehmigung ein und lass PRs, die HeyDeer genehmigen darf auf PRs mit niedrigem und mittlerem Risiko. Dann genehmigt HeyDeer routinemäßige Pull Requests, sobald keine Befunde mehr offen sind. Pull Requests mit hohem Risiko warten auf eine Person, und die Prüfung nennt den Grund.

Ist in deinen Branch-Regeln genau eine Genehmigung erforderlich, können routinemäßige Pull Requests gemergt werden, ohne auf einen Prüfer zu warten. Aktiviere Dismiss stale pull request approvals when new commits are pushed, damit jede Genehmigung den neuesten Code abdeckt.

Standards als Repository-Prüfungen festhalten

Eine Anforderung, die deine Prüfer in Kommentaren immer wieder anmerken, gehört in eine Repository-Prüfung. Lege für jede Anforderung eine Markdown-Datei in .agents/checks/ an, und HeyDeer wendet sie auf jeden Pull Request an, der passende Dateien ändert. Siehe Repository-Prüfungen.

.agents/checks/migrations.md

---
files: "migrations/**/*.sql"
---
The previous release keeps running while a migration
deploys. Report a migration that:

- drops or renames a table or column that code on the
  base branch still uses;
- adds a NOT NULL column without a default;
- creates an index on an existing table without
  CONCURRENTLY.

Was HeyDeer übernimmt

  • Details und Randfälle. HeyDeer prüft bei jedem Pull Request Fehlerbehandlung, Grenzwerte, Nebenläufigkeit und Aufrufer, die durch eine Änderung nicht mehr funktionieren.
  • Genau im Detail. Bei 1.000 internen Pull Requests hat HeyDeer die Korrektheit im Detail genauer geprüft als menschliche Prüfer.