ベストプラクティス
ノイズを減らす
HeyDeer の投稿がチームにとって多すぎる場合は、以下からノイズの種類を探し、その対処法を適用してください。上の行ほど、少ない労力で大きな効果があります。
対処法
| ノイズ | 対処法 | 詳細 |
|---|---|---|
| 対応しない指摘事項が多すぎる | 「フィードバックの範囲」を「簡潔」に切り替えます。先に範囲を比較するには、HeyDeer で最近のレビューを開き、「フィードバックの範囲をプレビュー」を使います。 | フィードバックの範囲 |
| 自動生成コードへのコメント | ベースブランチの .gitattributes で、そのファイルに linguist-generated を指定します。 | HeyDeer が読み込む情報 |
| ボットや使い捨てのプルリクエストのレビュー | 「作成者のアカウント」が「次のいずれでもない」→「ボット」や、「PR ラベル」が「次のいずれでもない」→ skip-review などの自動レビューのフィルターを追加します。 | レビューのフィルター |
| 修正しないと決めた指摘事項 | 理由を添えて返信するか、スレッドを解決済みにします。書き込み権限を持つ人が判断すると、HeyDeer はその問題を再び指摘しなくなります。 | フォローアップレビュー |
| 誰も対応しない種類のコメント | レビューへの指示または AGENTS.md に、コメントしなくてよい内容を、範囲を絞って理由とともに書きます。「パフォーマンスについてコメントしない」のような大まかなルールは避けてください。 | レビューガイダンスの書き方 |
| 関係のないファイルでチェックが反応する | files パターンを絞り込み、テストやフィクスチャを除外します。 | 効果的なチェックの書き方 |
| プッシュのたびに行われるフォローアップレビュー | 「新しい変更のみレビュー」をオンのままにし、「PR ごとの自動レビュー上限」を設定するか、「PRごとに1回」を使います。 | 自動レビュー |
| プルリクエストの会話が長くなる | 「対応済みの HeyDeer スレッドを解決済みにする」をオンのままにするか、「PR にレビューコメントを投稿」をオフにして、HeyDeer Review チェックにレビューを表示させます。 | 結果の公開 |
例
.gitattributes で自動生成ファイルを指定する例：
src/generated/** linguist-generated
*.pb.go linguist-generated=true対象外にする内容を絞り込んだルールの例：
## 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.