ベストプラクティス
チームへの展開
HeyDeer は段階的に導入し、チームが結果を信頼できるようになってからマージの判定に使いましょう。
始める前に
各段階の設定はワークスペース管理者が変更します。レビューは、書き込み権限を持つ人なら誰でも依頼できます。ワークスペースのメンバーを参照してください。
すべてのプランに月次クレジットが含まれます。新しいワークスペースは無料プランで始まり、初月は 1,000 クレジットが付与されます。無料プランを含むすべてのプランで、基本料金 1,000 クレジットあたり $10 でクレジットを追加できます。
クレジットや支払いに関するメールは、ワークスペース設定 → 通知のアドレスに届きます。チーム用アドレスなど、チームが確認できるアドレスを設定してください。詳しくは通知メールをご覧ください。
導入の段階
- 任意:チームに見せる前に HeyDeer を試します。ワークスペース設定 → レビュールール → 結果の公開で、GitHub チェックを公開とPR にレビューコメントを投稿をオフにします。レビューを開始でレビューを依頼し、レビュー履歴ページで結果を確認します。次の段階に進む前に、両方のオプションをオンに戻してください。
- いくつかのプルリクエストで試します。セットアップ後に HeyDeer がレビューをカスタマイズを表示したら、プルリクエストを自動でレビューをオフにして続けるを選び、依頼があったときだけレビューするようにします。そのうえで、種類の異なるオープンなプルリクエストいくつかに
@heydeer reviewとコメントし、指摘事項をレビュアーの指摘と比較してください。 - 見つかった不足を補います。それらのレビューで必要だとわかったものだけを追加します。コーディング規約は AGENTS.md に、要件はリポジトリのチェックに、優先事項はレビューへの指示に書きます。HeyDeer が読み込む情報を参照してください。
- 1~2 個のリポジトリで自動レビューをオンにします。リポジトリで対象のリポジトリを選択し、タイミングを変更を選択します。それらのレビューに問題がなければ、ワークスペース設定 → レビュールール → レビューのタイミングでワークスペースのタイミングを設定します。
- チームに合った構成に移行します。HeyDeer Review チェックを必須にし、自動承認を使うかどうかを決めます。コードレビューのないチームまたは人のレビュアーがいるチームを参照してください。
- 支出の管理を設定します。有料プランでは、自動チャージを有効にして使用量の上限を設定してください。詳しくは自動チャージと使用量の上限をご覧ください。
- HeyDeer の使い方をチームに伝えます。PR コメントのコマンドと、指摘事項を見送る方法を共有します。
想定したタイミングでプルリクエストがレビューされない場合は、トラブルシューティングを参照してください。
次の段階に進むタイミング
最近のレビューで次のすべてを満たしたら、次の段階に進みます:
- チームがほとんどの指摘事項に対応している。
- 見送られた指摘事項に、レビューへの指示やリポジトリのチェックで解消できる共通のパターンがない。パターンがある場合は、ノイズを減らすを参照してください。
- 実行されなかったリポジトリのチェックなどのレビューの注意事項がなく、レビューが完了している。
数週間後に最近のレビューを読み返します。ガイダンスを適切な置き場所に移し、レビューに何の影響も与えない指示やチェックは削除します。