GitHub 上のレビュー

PR コメントのコマンド

プルリクエストにコメントして、HeyDeer のレビューを依頼したり、自動レビューを一時停止したり、Autopilot を開始したりできます。コマンドは、レビューのタイミングの設定にかかわらず、接続されたすべてのリポジトリで使えます。

コマンド

alexがコメントしました

@heydeer review

HeyDeer は依頼を受け付けるとコメントに 👀 を付け、レビューが完了すると外します。

コマンド	動作
`@heydeer review`	リポジトリのデフォルトのレビューの深さとフィードバックの範囲で、現在のコミットをレビューします。新しい変更のみレビューがオンの場合は、前回のレビュー以降の変更を対象にします。フォローアップレビューを参照してください。
`@heydeer full review`	プルリクエスト全体をもう一度レビューします。
`@heydeer pause`	このプルリクエストの自動レビューを停止します。待機中のレビューは続行され、レビューの依頼も引き続きできます。
`@heydeer resume`	このプルリクエストの自動レビューを再開します。レビューは開始しません。
`@heydeer autopilot`	Autopilot を開始します。HeyDeer がこのプルリクエストの未対応の項目を修正してブランチにプッシュし、マージできる状態になるまで変更ごとにレビューします。
`@heydeer autopilot stop`	このプルリクエストの Autopilot を停止します。

結果は公開設定に従います。HeyDeer がレビューを実行できない場合や、レビューが失敗またはキャンセルされた場合は、HeyDeer がコメントに返信します。一時停止と再開にはすぐに返信します。Autopilot のコマンドにはリアクションが付き、Autopilot 自身のコメントで作業の状況がわかります。

依頼したレビューは、他のレビューと同様に課金されます。クレジットの仕組みを参照してください。PR ごとの自動レビュー上限には数えられません。

同じコミットのレビューが待機中または実行中の場合、@heydeer review だけを含むコメントは、新しいレビューを開始せず、そのレビューに加わります。追加のクレジットは消費しません。コメントには通常どおり 👀 が付き、レビュー結果も通常どおり報告されます。そのレビューは依頼後に投稿されたコメントを読みません。それらを含めるには、完了後にもう一度レビューを依頼してください。

HeyDeer によるコメントの読み取り方

新しい PR コメントまたはインラインレビューコメントの任意の位置にコマンドを含めます。インラインコメント内のコマンドでも、その行だけでなく、通常どおりプルリクエスト全体がレビューされます。
コマンドは、コード、引用、HTML コメントの中ではなく、プレーンテキストで書きます。HeyDeer は、編集されたコメントとボットのコメントを無視します。
コメントに複数のコマンドが含まれている場合、HeyDeer は最初のコマンドだけを実行します。
レビューの深さやフィードバックの範囲を選ぶには、HeyDeer からレビューを開始してください。

それ以外で @heydeer をメンションすると、HeyDeer に質問や作業を依頼できます。@heydeer をメンションを参照してください。

コマンドに 👀 も返信も付かない場合は、トラブルシューティングを参照してください。

不足しているコンテキストを補う

レビューで要確認として質問された場合や、指摘事項で考慮されていない事情がある場合は、新しいコメントで説明します。同じコメントに @heydeer review を含めると、その説明を踏まえたレビューを依頼できます。

alexがコメントしました

空の catch は意図的なものです。キャッシュは任意で、キャッシュミス時はデータベースにフォールバックします。@heydeer review

説明を添えて依頼するたびに、コードが変わっていなくても最新の議論を読む新しいレビューが実行されます。コマンドを含まない返信ではレビューは開始されません。

指摘事項に対応しないと決めた場合は、指摘事項を見送るを参照してください。

コマンドを実行できるユーザー

コマンドを実行できるユーザーは、レビューを依頼できるユーザーの設定で決まります。設定場所はワークスペース設定 → レビュールール → 手動レビューの権限、またはリポジトリのレビュールールです。

オプション	レビューを依頼できるユーザー
リポジトリへの書き込み権限を持つ全員	デフォルト。write、maintain、admin のいずれかの権限を持つ全員。
書き込み権限を持つ指定ユーザーまたはチーム	「GitHub ユーザー名」または「チーム」に含まれ、かつ書き込み権限を持つユーザー。

HeyDeer から開始するレビューやチェックのボタンから開始するレビューにも、同じルールが適用されます。自動レビューのフィルターは、依頼されたレビューを制限しません。

HeyDeer からレビューを開始する

HeyDeer でレビュー履歴を開き、レビューを開始を選択します。
リポジトリとプルリクエストを選択します。選択できるのは、書き込み権限を持つリポジトリだけです。
レビューの深さやフィードバックの範囲を変更するには、レビューのオプションを開きます。どちらもリポジトリのデフォルト値が初期設定されています。
レビューを実行するを選択します。