レビューへの指示

指示を追加

1. ワークスペース設定 → レビューへの指示を開きます。特定のリポジトリ用には、リポジトリ → （リポジトリ） → レビューへの指示を開きます。
2. プレーンテキストまたは Markdown で、最大 12,000 文字まで記述します。
3. ワークスペースの指示を保存またはリポジトリの指示を保存を選択します。

• ワークスペースの指示はすべてのリポジトリに適用されます。リポジトリの指示はそれに追加され、両者が矛盾する場合はリポジトリの指示が優先されます。
• リポジトリのページでは、統合された指示をプレビューで両方を順番に確認できます。
• 変更は、保存後に依頼されたレビューに適用されます。
• 指示を編集できるのはワークスペース管理者だけです。
• パスワード、トークン、その他の機密情報を指示に含めないでください。

指示に書く内容

指示には、HeyDeer がレビューするときにだけ関係するガイダンスを書きます。優先すべきこと、触れなくてよいこと、チームで使う用語、フィードバックの書き方などです。

コーディング規約は AGENTS.md に書くと、コーディングエージェントもそれに従います。該当するすべてのプルリクエストで HeyDeer に必ず検証させたい要件は、リポジトリのチェックに書きます。

こうしたガイダンスを、対象のコードと同じ場所でリポジトリに置きたい場合は、REVIEW.md を使います。REVIEW.md はプルリクエストで変更できるため、変更されてはならない内容は指示に書いてください。

指示は REVIEW.md、AGENTS.md、スキルより優先されますが、リポジトリのチェックの実行を止めることはできません。ガイダンスが矛盾する場合を参照してください。

効果的な指示の書き方

何かを書く前に、HeyDeer にいくつかのプルリクエストをレビューさせてください。繰り返し発生する見逃しや不要なコメントに対して指示を追加します。一度に追加するのは数個にとどめ、次のレビューを読んで効果を確認します。

• 指示は「優先事項」「対象外」「用語」「フィードバック」など、いくつかの見出しの下にまとめます。
• 箇条書き 1 項目につき 1 つの指示を書き、対象となるパス、関数、ライブラリを明記します。
• 理由が明らかでない場合は、理由を添えます。
• 除外は範囲を絞ります。「スクリプトにはコメントしない」ではなく「scripts/one-off/ のファイルにはコメントしない」と書きます。前者では本当のバグまで隠れてしまいます。
• HeyDeer の報告方法は設定で指定します：レビューの言語、フィードバックの範囲、自動承認。

## Priorities

- Code under src/payments/ is high risk. Look hardest at retries,
  refunds and anything that could charge a customer twice.

## Leave alone

- Files under scripts/one-off/. They run once by hand and are deleted.
- Formatting. The formatter runs in CI.

## Terms

- A "workspace" is a customer account, not a folder on disk.

## Feedback

- Name the input that triggers a bug, and suggest the smallest fix.

指示が無視されているように見える場合は、トラブルシューティングを参照してください。