Best Practices
Rauschen reduzieren
Wenn HeyDeer mehr veröffentlicht, als Ihr Team lesen möchte, suchen Sie unten die Art des Rauschens und wenden Sie die passende Lösung an. Die ersten Zeilen bewirken mit dem geringsten Aufwand am meisten.
Lösungen
| Rauschen | Lösung | Details |
|---|---|---|
| Zu viele Befunde, auf die Sie nicht reagieren würden | Stellen Sie „Feedback-Umfang“ auf „Kompakt“ um. Um die Stufen vorher zu vergleichen, öffnen Sie eine aktuelle Prüfung in HeyDeer und verwenden Sie „Feedback-Umfang in der Vorschau“. | Feedback-Umfang |
| Kommentare zu generiertem Code | Markieren Sie die Dateien in .gitattributes auf dem Basis-Branch als linguist-generated. | Was HeyDeer liest |
| Prüfungen von Bot- oder Wegwerf-Pull-Requests | Fügen Sie „Filter für automatische Reviews“ hinzu, etwa Kontotyp des Autors → Ist keines von → Bot oder PR-Labels → Ist keines von → skip-review. | Prüffilter |
| Ein Befund, den Sie bewusst nicht beheben | Antworten Sie mit der Begründung oder markieren Sie den Thread als erledigt. Eine Entscheidung durch jemanden mit Schreibzugriff verhindert, dass HeyDeer den Befund erneut anspricht. | Folgeprüfungen |
| Eine Art von Kommentar, auf die niemand reagiert | Legen Sie in Prüfanweisungen oder AGENTS.md fest, wozu nicht kommentiert werden soll, eng gefasst und mit Begründung. Vermeiden Sie breite Regeln wie „Keine Kommentare zur Performance“. | Prüfhinweise schreiben |
| Eine Prüfung, die bei Dateien anschlägt, um die es nicht geht | Grenzen Sie ihre files-Muster ein und schließen Sie Tests oder Fixtures aus. | Wirksame Prüfungen schreiben |
| Folgeprüfungen bei jedem Push | Lassen Sie „Nur neue Änderungen prüfen“ aktiviert und legen Sie „Maximale automatische Reviews pro PR“ fest, oder verwenden Sie „Einmal pro PR“. | Automatische Reviews |
| Eine lange Unterhaltung im Pull Request | Lassen Sie „Bearbeitete HeyDeer-Threads als erledigt markieren“ aktiviert, oder deaktivieren Sie „Review-Kommentare im PR veröffentlichen“, sodass der Check HeyDeer Review die Prüfung enthält. | Ergebnisse veröffentlichen |
Beispiele
Generierte Dateien in .gitattributes:
src/generated/** linguist-generated
*.pb.go linguist-generated=trueEng gefasste Regeln dazu, was unkommentiert bleiben soll:
## Leave alone
- Files under scripts/one-off/. They run once by hand and are deleted.
- Missing input validation in internal/admin-cli/. It only runs
locally with trusted input.