ベストプラクティス
チームへの展開
HeyDeer は段階的に導入し、チームが結果を信頼できるようになってからマージの判定に使いましょう。
導入の段階
- いくつかのプルリクエストで試す。新しいワークスペースは「手動のみ」で始まります。種類の異なる最近のプルリクエストいくつかに @heydeer review とコメントし、指摘事項をレビュアーの指摘と比較します。
- 見つかった不足を補う。それらのレビューで必要だとわかったもの(規約、常に守るべきルール、優先事項)だけを追加します。ルールの置き場所を参照してください。
- 自動レビューをオンにする。まず 1〜2 個のリポジトリで「PRごとに1回」から始め、その後「PR ごとの自動レビュー上限」を設定した「プッシュごと」に移行し、組織のタイミングを設定します。自動レビューを参照してください。
- 判定には使わずにチェックを公開する。デフォルトでは、レビューで問題が見つかっても HeyDeer Review チェックは合格になります。チームが指摘事項に慣れるまでは、その設定のままにしておきます。
- チームが信頼できるようになったらチェックを必須にする。GitHub のブランチルールで HeyDeer Review を必須チェックにしてから、「問題が見つかった場合はチェックを失敗にする」をオンにします。以降、自動でレビューされないリビジョンは @heydeer review を待つことになります。HeyDeer Review チェックを参照してください。
- 自動承認について決める。デフォルトではオフです。オンにする場合は「単純な変更のみ」から始め、ブランチルールで古い承認を取り消すよう設定します。自動承認を参照してください。
- 通知と支出の管理を設定する。クレジットとトライアルのお知らせを受け取るワークスペースのメールアドレスを追加し、使用量の上限を設定して自動チャージをオンにします。通知と自動チャージと使用量の上限を参照してください。
- HeyDeer との付き合い方をチームに伝える。PRコメントのコマンド、返信で指摘事項を見送る方法、レビューしやすいプルリクエストの書き方を共有します。
チェックリスト
- 「手動のみ」で実際のプルリクエストをいくつかレビューした
- それらのレビューで不足していた点について、AGENTS.md、チェック、指示を追加した
- 自動生成ファイルを指定し、ボットのプルリクエストを除外した
- 「PRごとに1回」をオンにし、その後レビュー上限付きの「プッシュごと」に切り替えた
- 問題があっても失敗しない設定で HeyDeer Review チェックを公開した
- チェックを必須にし、問題があれば失敗にするかどうかを決めた
- 自動承認について決めた
- 通知先メールアドレス、自動チャージ、使用量の上限を設定した
- コマンドと指摘事項の見送り方をチームに共有した
数週間後に最近のレビューを読み返し、置き場所が不適切なルールを移動し、効果のないルールを削除します。