ベストプラクティス
ルールの置き場所
ルールの置き場所は、その目的と、誰が変更できるべきかによって選びます。
置き場所を選ぶ
| HeyDeer に伝えたいこと | 置き場所 | HeyDeer の読み込み元 |
|---|---|---|
| チームの規約とプロジェクトのコンテキスト：構成、命名、使用するヘルパー | AGENTS.md | プルリクエスト。下位のディレクトリにあるファイルは、そのディレクトリに適用されます。 |
| 特定のファイルに触れるすべてのプルリクエストが満たすべきルール | .agents/checks/ | ベースブランチ |
| 複数のチェックで共有する手法やドメイン知識 | .agents/skills/ | プルリクエスト |
| すべてのリポジトリに共通するレビューの優先事項、対象外にする内容、トーン | 組織の指示 | 「組織設定」→「レビューへの指示」 |
| 同様の内容を 1 つのリポジトリに対して | リポジトリの指示 | 「リポジトリ」→（リポジトリ）→「レビューへの指示」 |
| チケットや社内ドキュメントなど、リポジトリ外のコンテキスト | MCPサーバー | 「組織設定」→「MCPサーバー」、またはリポジトリの「MCPサーバー」 |
| 自動でレビューするプルリクエスト | 自動レビューのフィルター | レビュールール |
| 投稿する指摘事項の量 | フィードバックの範囲 | レビュールール |
| HeyDeer が使う言語 | レビューの言語 | レビュールール |
レビューへの指示と AGENTS.md が矛盾する場合は、レビューへの指示が優先されます。
ベースブランチかプルリクエストか
チェックはベースブランチから読み込まれるため、プルリクエストが自身の変更で違反するチェックを弱めることはできません。新しいチェックは、マージ後にレビューされるプルリクエストに適用されます。
AGENTS.md とスキルはプルリクエストから読み込まれるため、常にレビュー対象のコードと一致しますが、プルリクエストを作成する人なら誰でも編集できます。プルリクエストの内容にかかわらず守られるべきルールは、チェックまたはレビューへの指示に置いてください。