heydeer
ベストプラクティス

コードレビューのないチーム

エージェントが main に直接コミットしたり、CI が通ればプルリクエストをマージしたりして、誰も読まないまま変更が main に入っている場合は、この構成を使います。HeyDeer がプッシュごとにレビューし、HeyDeer が承認すると GitHub がプルリクエストをマージします。

推奨構成

エージェントがプルリクエストを作成する
HeyDeer がプッシュごとにレビューする
チェックが成功し、HeyDeer が承認する
GitHub がプルリクエストをマージする
HeyDeer が指摘事項を報告するとチェックは失敗し、何もマージされません。エージェントが修正をプッシュすると、HeyDeer が新しいコミットをレビューします。
  1. エージェントには main に直接コミットさせず、変更ごとにブランチにプッシュしてプルリクエストを作成させます。
  2. ワークスペース設定 → レビュールール → レビューのタイミングで、プッシュごとを選択します。自動レビューを参照してください。
  3. 結果の公開で、問題が見つかった場合はチェックを失敗にするをオンにします。HeyDeer Review チェックを参照してください。
  4. 結果の公開で自動承認をオンにします。これで HeyDeer は、完了したレビューで指摘事項が残っていなければプルリクエストを承認します。自動承認を参照してください。
  5. 高リスクの変更を誰が承認するかを決めます。デフォルトでは、高リスクのプルリクエストは人の承認を待ちます。これらも HeyDeer に承認させるには、HeyDeer が承認できる PRをすべてのリスクレベルの PRに設定します。
  6. GitHub の main のブランチルールで、Require a pull request before merging を必須の承認数 1 でオンにします。Dismiss stale pull request approvals when new commits are pushed もオンにします。
  7. 同じルールで、CI のチェックに加えて HeyDeer Review チェックを必須にします。
  8. リポジトリの GitHub 設定で Allow auto-merge をオンにします。次に、各プルリクエストで自動マージを有効にするか、プルリクエストの作成後にエージェントに gh pr merge --auto --squash を実行させます。
HeyDeer がこの変更を承認しました
すべてのチェックに合格しました
HeyDeer Review — レビューが完了しました。問題は見つかりませんでした
CI / test — 成功
自動マージがオンです:すべての要件を満たすと、GitHub がこのプルリクエストをマージします。
HeyDeer が承認し、すべての必須チェックが成功すると、GitHub がプルリクエストをマージします。

エージェントに指摘事項へ対応させる

HeyDeer は指摘事項をプルリクエストのレビューとして投稿し、HeyDeer Review チェックにレポート全体を載せます。エージェントには、プッシュのたびにレビューを読み、指摘事項を修正して再度プッシュさせます。その後、HeyDeer が新しいコミットをレビューします。

指摘事項を見送るには、書き込み権限を持つ人が、その会話で判断の理由を説明するか会話を解決済みにしてから、@heydeer review とコメントします。指摘事項を見送るを参照してください。

代わりに、選んだ指摘事項を HeyDeer に別の PR で修正させるには、レビューでHeyDeer で修正を選択します。HeyDeer で修正を参照してください。

チームの基準をチェックとして書く

レビューで要件を徹底すると、エージェントはその要件をより確実に満たします。要件ごとに .agents/checks/ に Markdown ファイルを追加すると、HeyDeer は該当するファイルを変更するすべてのプルリクエストにその要件を適用します。リポジトリのチェックを参照してください。

.agents/checks/tenant-scope.md

---
files:
  - "src/db/**/*.ts"
  - "!**/*.test.ts"
---
Every query that reads or writes customer data must be
scoped to one tenant, taken from the request context and
never from request parameters.

別のレビューが役立つ理由

CI が検出できるのは、テストでカバーしている範囲だけです。レビューがないと、次の 2 つの問題が見逃されます:

  • コードを書いたモデルは、自分の作業を確認するよう指示しても、自身の推論をそのまま受け入れ、自身のミスを見落としがちです。
  • エージェントが同じコードを何度も修正すると、変更のたびに、以前の変更で正しくできていた部分が気づかないうちに壊れることがあります。

HeyDeer はコードを書いたエージェントとは切り離して各プルリクエストをレビューし、投稿前に各指摘事項をコードと照合して検証します。以降のプッシュでは、フォローアップレビューが以前の問題を再確認します。