ベストプラクティス
人のレビュアーがいるチーム
マージ前にすべてのプルリクエストを人がレビューしている場合は、この構成を使います。HeyDeer が先に細部をチェックするので、レビュアーは設計やプロダクトの判断に集中できます。
推奨構成
プルリクエストが作成される
HeyDeer が細部をレビューする
作成者が指摘事項を修正する
レビュアーが設計を確認してマージする
- ワークスペース設定 → レビュールール → レビューのタイミングで、プッシュごとを選択します。自動レビューを参照してください。
- 結果の公開で、問題が見つかった場合はチェックを失敗にするをオンにします。HeyDeer Review チェックを参照してください。
- GitHub の main のブランチルールで、HeyDeer Review チェックを必須にします。これで、HeyDeer が最新のコミットをレビューし、指摘事項と以前の問題が修正されるか見送られた後にのみ、プルリクエストをマージできるようになります。
- レビュアーには、HeyDeer Review チェックが成功してからプルリクエストを読み始めてもらいます。そうすれば、設計、プロダクトの動作、HeyDeer が要確認に挙げた質問に集中できます。
一部のチェックが成功しませんでした
HeyDeer Review — レビューで対応が必要な問題が見つかりました必須
CI / test — 成功必須
マージはブロックされています
プルリクエストがPR ごとの自動レビュー上限に達した後など、HeyDeer が自動でレビューしないコミットも、誰かがレビューを依頼するまでマージをブロックします。トラブルシューティングを参照してください。
オプション:定型的な変更を自動承認する
自動承認をオンにして、HeyDeer が承認できる PRを低リスクと中リスクの PRのままにします。指摘事項が残っていない定型的なプルリクエストは HeyDeer が承認し、高リスクのプルリクエストは人の承認を待ちます。その理由はレビューに記載されます。
ブランチルールで必須の承認数を 1 にしておけば、定型的なプルリクエストはレビュアーを待たずにマージできます。すべての承認が最新のコードを対象とするよう、Dismiss stale pull request approvals when new commits are pushed をオンにしてください。
チームの基準をチェックとして書く
レビュアーがコメントで何度も繰り返している要件は、チェックにしましょう。要件ごとに .agents/checks/ に Markdown ファイルを追加すると、HeyDeer は該当するファイルを変更するすべてのプルリクエストにその要件を適用します。リポジトリのチェックを参照してください。
.agents/checks/migrations.md
---
files: "migrations/**/*.sql"
---
The previous release keeps running while a migration
deploys. Report a migration that:
- drops or renames a table or column that code on the
base branch still uses;
- adds a NOT NULL column without a default;
- creates an index on an existing table without
CONCURRENTLY.HeyDeer が引き受けること
- 細部とエッジケース。HeyDeer はすべてのプルリクエストで、エラー処理、境界値、並行処理、変更によって壊れる呼び出し元をチェックします。
- 細部まで正確。社内の 1,000 件のプルリクエストで、HeyDeer は細部の正しさを人のレビュアーよりも正確にレビューしました。