リファレンス

設定リファレンス

レビュールールのすべての設定とそのデフォルト値・効果に加え、HeyDeer のその他の設定の保存場所と制限をまとめています。

最初の 5 つの表は、ワークスペース設定 → レビュールールのセクションに対応しています。デフォルトは新しいワークスペースの初期値で、各設定からそれを説明するページにリンクしています。リポジトリは、カスタマイズするまでワークスペースの値に従います。設定の仕組みを参照してください。

レビューのタイミング

設定	デフォルト	動作
レビューのタイミング	手動のみ	HeyDeer がプルリクエストを自動でレビューするかどうか：PR ごとに 1 回、プッシュごと、手動のみ。
PR ごとの自動レビュー上限	5	プッシュごとの場合、成功した自動レビューがこの回数に達すると、そのプルリクエストの自動レビューを停止します：1、2、3、5、10、20、無制限。
PR がクローズされたら自動レビューを停止	オン	プルリクエストがクローズまたはマージされたときに、待機中および実行中の自動レビューを停止します。
自動レビューのフィルター	PR の状態 → ドラフトではない、PR のソース → 次のいずれか → 同じリポジトリ、および作成者 → 次のいずれでもない → dependabot[bot]、renovate[bot]、pre-commit-ci[bot]、snyk-io[bot]、snyk-bot	自動レビューの対象となるプルリクエストを、ラベル、作成者、チーム、アカウントの種類、ドラフトの状態、ソースで指定します。プルリクエストはすべての行に一致する必要があります。

レビュー方法

設定	デフォルト	動作
デフォルトのレビューの深さ	標準	標準または詳細。「詳細」は各手順により多くの時間をかけ、より多くのクレジットを使用し、有料プランが必要です。
新しい変更のみレビュー	オン	2 回目以降のレビューでは、前回のレビュー以降の変更だけを対象にし、以前の問題を再確認します。
フィードバックの範囲	バランス	確信度と深刻度に基づいて、HeyDeer が報告する指摘事項を決めます：簡潔、バランス、網羅的。
レビューの言語	English	指摘事項、HeyDeer Review チェック、コマンドへの返信など、HeyDeer が GitHub に投稿するすべての内容の言語：English, 简体中文, 日本語, Español, 한국어, Português (Brasil), Deutsch。コードとファイルパスはそのまま変わりません。
関連する Issue と PR を読む	オン	変更の背景を説明する、同じリポジトリ内の Issue やプルリクエストを HeyDeer が読めるようにします。
ウォークスルー	オン	変更のガイドを追加します。関連する編集をまとめ、重要なものを強調します。
リポジトリのスナップショットを保持	オン	大規模なリポジトリでは、デフォルトブランチのスナップショットからレビューをすばやく開始できます。スナップショットは、最後に使われてから 1 日後、またはこの設定をオフにしたときに削除されます。

結果の公開

設定	デフォルト	動作
自動承認	オフ	下記の 2 つの条件を満たすプルリクエストを HeyDeer が承認できるようにします。PR にレビューコメントを投稿がオンの場合にのみ機能します。
HeyDeer が承認できる PR	低リスクと中リスクの PR	HeyDeer が承認する最も高いリスクレベル：低リスクの PR、低リスクと中リスクの PR、すべてのリスクレベルの PRのいずれか。
残っていてもよい問題	未解決の問題なし	深刻度「低」の指摘事項や以前の問題が残っていても HeyDeer が承認できるかどうか：未解決の問題なしまたは深刻度「低」の問題を許可。
GitHub チェックを公開	オン	HeyDeer Review チェックにレビューの進捗と結果を表示します。
問題が見つかった場合はチェックを失敗にする	オフ	指摘事項、未解決または未確認の以前の問題、未完了のレビューがある場合にチェックを失敗にします。GitHub チェックを公開がオンの場合にのみ適用されます。
PR にレビューコメントを投稿	オン	各レビューをプルリクエストに投稿します。オフにすると、自動承認と会話の解決もオフになります。
対応済みの HeyDeer の会話を解決済みにする	オン	後のレビューで懸念が修正されたと判断するか、対応しないという判断を受け入れると、HeyDeer の会話を解決済みにします。

Autopilot

設定	デフォルト	動作
1 回の実行あたりの最大ラウンド数	5	Autopilot の実行がこのラウンド数に達すると停止します：3、5、8、10、12、15。

手動レビューの権限

設定	デフォルト	動作
レビューを依頼できるユーザー	リポジトリへの書き込み権限を持つ全員	PR コメントまたはチェックから HeyDeer にレビューを依頼できるユーザー。もう一方のオプションである書き込み権限を持つ指定ユーザーまたはチームでは、最大 100 個のユーザー名と、組織の場合は最大 30 個のチームを指定できます。

HeyDeer で設定する項目

レビューでは、HeyDeer がそのレビューをキューに入れた時点で保存されているレビュールール、指示、コネクタが使われます。プルリクエストでこれらを変更することはできません。

構成	場所	変更できるユーザー	ルールと制限
レビュールール	「ワークスペース設定」→「レビュールール」、または「リポジトリ」→（リポジトリ）→「レビュールール」	ワークスペース管理者	リポジトリは、カスタマイズするまで各ワークスペースのデフォルトに従います。
レビューへの指示	「ワークスペース設定」→「レビューへの指示」、または「リポジトリ」→（リポジトリ）→「レビューへの指示」	ワークスペース管理者	プレーンテキストまたは Markdown で、各レベルにつき最大 12,000 文字。矛盾する場合はリポジトリの指示が優先されます。
コネクタ	「ワークスペース設定」→「コネクタ」	GitHub 組織またはアカウントのオーナーでもあるワークスペース管理者	コネクタは有料プランで利用できます。ワークスペースごとに最大 50 個で、それぞれ公開 HTTPS エンドポイントで動作する Streamable HTTP サーバーです。

管理者がリポジトリの設定を変更できるのは、GitHub でそのリポジトリにアクセスできる場合だけです。ワークスペースのメンバーを参照してください。

リポジトリのファイル

HeyDeer は、レビュー対象のリポジトリにある次のファイルも読み込みます。プルリクエストから読み込まれるファイルは、そのブランチにプッシュできる人なら誰でも変更できます。プルリクエストで変更できるものを参照してください。

ファイル	読み込み元	ルールと制限
`AGENTS.md`, `CLAUDE.md`	プルリクエスト自身のバージョン	任意のディレクトリ。そのディレクトリ以下に適用され、より深い階層のファイルが優先されます。`AGENTS.md` がないディレクトリでは `CLAUDE.md` が読み込まれます。ルートから 1 つのディレクトリまでの合計で最大 32 KiB まで読み込まれ、残りは除外されます。
`REVIEW.md`	プルリクエスト自身のバージョン	任意のディレクトリ。そのディレクトリ以下の変更に適用され、より深い階層のファイルが優先されます。シンボリックリンクは読み込まれません。
`.agents/checks/*.md`	プルリクエスト自身のバージョン	チェックごとに 1 つの Markdown ファイルを `.agents/checks` 直下に置き、フロントマターに `files` を記述します。名前は英字または数字で始め、英字、数字、`.`、`_`、`-` を使います。1 ファイルあたり最大 16,000 バイト。1 回のレビューで実行される該当チェックは、ファイル名順に最大 10 件です。
`.agents/skills/`	プルリクエスト自身のバージョン	チェックで指定された場合に使用されます。各スキルは `SKILL.md` を含むフォルダーで、名前には英小文字、数字、単一のハイフンを使い、64 文字以内にします。
`.gitattributes`	ベースブランチ	`linguist-generated` が指定されたファイルと、すでにあるロックファイル（`-linguist-generated` が指定されたものを除く）は、レビューから除外されます。ベースブランチにマージできる人なら誰でも変更できます。

チェックのフロントマター

各チェックは、2 つの --- 行で囲まれた YAML フロントマターで始まります。下記以外のキーは HeyDeer では無視されます。

キー	値	効果
`files`	パターン、またはパターンのリスト	必須。ない場合、HeyDeer はそのファイルを無視します。チェックの対象となる変更ファイルを指定します。パターンの先頭に `!` を付けるとファイルを除外できます。除外パターンには、対象を含めるパターンが 1 つ以上必要です。
`skills`	スキル名、または名前のリスト	任意。チェックで使用するスキル。プルリクエストから読み込まれます。スキルが見つからなくてもレビューは止まりません。