レビューの読み方
HeyDeer は指摘事項を GitHub のプルリクエストレビューとして投稿し、各指摘事項が対象とする行にインラインコメントを付けます。
HeyDeer が投稿する内容
GitHub 上のレビューには要約がありません。要約と指摘事項の完全な一覧は、HeyDeer Review チェックと HeyDeer で確認できます。
レビューコメントには、レビューの警告、追加の指摘事項、承認の理由(ある場合)だけが記載されます。投稿する内容がないレビューではコメントは追加されません。レビューが GitHub に投稿するには長すぎる場合、HeyDeer は一部の指摘事項を省略し、View all findings in HeyDeer リンクを追加します。
HeyDeer がプルリクエストを承認するのは自動承認がオンの場合だけで、議論ですでに挙げられた問題は繰り返しません。フォローアップレビューを参照してください。
「PR にレビューコメントを投稿」がオフの場合、レビューはチェックにのみ表示されます。結果の公開を参照してください。
指摘事項の構成
| 部分 | 表示内容 |
|---|---|
| 見出し | 重大度とタイトル。例:HIGH: 404 のときにリトライのループが止まらない |
| 説明 | 問題の内容と、それが引き起こす影響。 |
| 修正の提案 | 文章による修正方法。 |
| 変更の提案 | GitHub の suggestion、または読み取り専用の diff による正確な編集内容。 |
| チェック | その指摘事項を挙げたリポジトリのチェック。 |
| 影響を受けるコード | コメントが対象の行に付いていない場合の、その行へのリンク。 |
重大度は緊急、高、中、低のいずれかで、影響の大きさを表し、HeyDeer の確信度とは別のものです。投稿する指摘事項を増減するには、確信度で絞り込むフィードバックの範囲を変更してください。
コミットできる suggestion は、コメントが置き換え対象の行にぴったり付いている場合にのみ表示されます。それ以外の場合、変更は読み取り専用の diff になります。HeyDeer はフォーマッターやテストを実行しないため、suggestion はコミットする前に内容を確認してください。
GitHub では、インラインコメントは diff 内の行にしか付けられません。変更によって壊れる未変更の呼び出し元など、それ以外のコードに関する指摘事項は、レビューコメントの「追加の指摘事項」に記載されます。
レビューの警告
何らかの理由でレビューが制限された場合、レビューコメント、チェック、HeyDeer に「レビューの警告」が表示されます。
| 警告 | 対処方法 |
|---|---|
| 確信度の低い指摘事項は省略されました | 1 回のレビューでは、確信度の高い上位 30 件の指摘事項が保持されます。それらに対応してから、もう一度レビューを依頼してください。 |
| 最初の 10 個のチェックのみが選択されました | 適用されるリポジトリのチェックは、ファイル名順で最大 10 個です。チェックのファイルパターンを絞り込んでください。 |
このプルリクエストは .agents/ を変更しており、新しいチェックの設定が無効です | マージする前に設定を修正してください。修正しないと、HeyDeer はそのブランチへのプルリクエストをレビューできません。 |
| 一部の指摘事項またはスレッドの評価が無効か不完全でした | 完全な結果を得るには、もう一度レビューを依頼してください。 |
警告のあるレビューは不完全なものとして扱われます。HeyDeer はそのレビューで承認せず、チェックも成功を報告せず、次のレビューではプルリクエスト全体が対象になります。
レビューの言語
「レビューの言語」は、指摘事項、要約、警告、スレッドでの HeyDeer の返信の言語を設定します。英語(デフォルト)、簡体字中国語、日本語、スペイン語、韓国語、ポルトガル語(ブラジル)、ドイツ語から選べます。コードとファイルパスはそのまま変わりません。
「組織設定」→「レビュールール」の「レビュー方法」、またはリポジトリの「レビュールール」で設定します。
HeyDeer でのレビュー
すべてのレビューには HeyDeer 上のページがあります。「レビュー」、チェックの Details リンク、または View all findings in HeyDeer から開けます。ページには、レビューのきっかけ、「新しい変更」と「PR 全体」のどちらを対象にしたか、「使用済みクレジット」、フィードバックの範囲内のすべての指摘事項、「議論で見送られた懸念」の下に一覧表示される懸念が表示されます。
「フィードバックの範囲をプレビュー」では、各フィードバックの範囲でどの指摘事項が残るかを、何も変更せずに確認できます。書き込み権限を持つ人は「レビューをキャンセル」でレビューを停止できますが、すでに使用したクレジットは返還されません。