pr-self-review

PR のセルフレビュー用メモ

変更された動作、影響を受ける呼び出し元、分かりにくい選択について、チームメイトが理解できるようにする下書きメモです。このワークフローで許可されるのは、調査と下書きの作成であり、追加のコード変更やチームメイトへの返信ではありません。

既存の PR については、ターゲットと作成者を読んで、リポジトリ、オープン中の PR、作成者、現在のヘッドを確認します。PR が存在しない場合は、ローカルの差分を調べ、非公開の下書きを続けます。

差分、既存の議論、影響を受ける利用側を確認します。理由を裏付ける必要がある場合は、履歴やリンクされた課題をたどります。意味のある変更について、異なるレビュアーの疑問を網羅します。必要な数や上限はありません。複雑な変更には短いメモがいくつか必要になる場合があり、単純な変更には何も必要ない場合があります。

説明を選んだり下書きしたりする際は、メモの書き方を参照してください。各メモは簡潔で具体的かつ根拠のあるものにします。作成者の意図をでっち上げたり、Pete 個人として発言したりしないでください。永続的なコードコメントが必要な場合は、その編集がすでに許可されている場合を除き、別途指摘します。

投稿前に、公開する文面をすべて提示します。任意のレビュー概要に続けて、各メモのパス、サイド、行、本文を示します。根拠となる情報は、提案するコメントの外に記載します。有用な指摘がすべてインラインの場合、概要は none とします。コメント数やステータスの告知は追加しないでください。

文面とアンカーの承認を待ちます。提示された正確な文面と投稿指示があれば承認とみなし、二度尋ねないでください。承認済みの文面またはアンカーを変更する必要がある場合は、まず変更案を提示して承認を得ます。実行のたびに既存のコメントを確認し、重複を避けます。

承認後、GitHub への投稿を読みます。承認済みのメモを 1 件のレビューとして投稿し、GitHub に意図した文面とアンカーが保存されたことを確認します。作成者が異なる場合、PR がクローズされている場合、または承認がない場合は投稿しないでください。可能な範囲で非公開の下書きを続けます。