レビューしやすい PR

プルリクエストの目的を絞る

1 つのことだけを行うプルリクエストには、そのことに関する指摘事項が返ってきます。リファクタリング、名前の変更、ファイルの移動は動作の変更と分けてください。混ざると、実際に変更された行が埋もれてしまいます。

意図を説明し、Issue をリンクする

HeyDeer はタイトルと説明を読みます。変更の目的、最も自信のない部分、意図的に除外したことを書いてください。作成者が書き込み権限を持っている場合、「リトライは対象外。#412 で追跡中」のように明記したトレードオフは、指摘事項を見送るのと同様に判断として扱われます。

Issue もリンクしてください。「関連する Issue を読む」がオン（デフォルト）の場合、HeyDeer は Issue を読んで、変更が満たすべき要件を把握できます。HeyDeer が読み込む情報を参照してください。

自動生成ファイルを指定する

.gitattributes で自動生成コードに linguist-generated を指定すると、HeyDeer はそのコードを除外します。HeyDeer はこの属性をベースブランチから読み込むため、この変更は先に単独のプルリクエストでマージしてください。

作業中はドラフトで作成する

自動レビューはデフォルトでドラフトをスキップし、レビュー可能に変更した時点でプルリクエストを対象にします。早めにフィードバックが欲しい場合は、ドラフトで @heydeer review とコメントしてください。レビューのフィルターを参照してください。

修正は新しいコミットとしてプッシュする

フォローアップレビューは前回のレビュー以降の変更を確認するため、修正が新しいコミットとして届くと最も効果的です。対象ブランチのマージやリベースは問題ありません。関連する修正はまとめてプッシュすると、自動レビューの回数を抑えられます。フォローアップレビューを参照してください。

見送る指摘事項には返信する

「修正しない」とだけ書くのではなく、スレッドで理由を添えて返信するか、スレッドを解決済みにしてください。書き込み権限を持つ人の判断は、その問題を再び指摘しないよう HeyDeer に伝えます。ノイズを減らすを参照してください。