trailofbits/review-pr

PRレビュー

ブランチの変更範囲のみをレビューし、リポジトリ全体はレビューしません。

1. 差分を確定する: git diff <base>...HEAD （ワーキングツリーにブランチに属する未コミットの変更がある場合は git diff <base> も使用する）。ベースブランチは呼び出し元が指定し、指定がない場合は main にフォールバックします。
2. 変更されたすべてのハンクの正当性をレビューする: エッジ入力での誤った結果、未処理のエラーパス、関数名や呼び出し元と矛盾する動作がないか確認します。
3. 変更された動作に対するテストカバレッジを確認する: 新しいロジックにそのエッジケースをテストするテストがない場合は、指摘事項となります。
4. 差分によって古くなったドキュメントを確認する: READMEやドキュメント内でベースブランチでは正しかったが、変更後は誤りとなる記述がないか確認します。
5. 発見されたすべての欠陥を、それぞれ重要度を付けて報告する。軽微なものや情報提供の指摘も含めます。ブランチが触れていないファイルの欠陥は報告しないでください。それらはプルリクエストの範囲外です。