読者です 読者をやめる 読者になる 読者になる

Perl日記

PerlとかRubyとかPHPとかPythonとか

Github上のPull Requestで気をつけていること

ブランチ→ブランチのPR

PRするとき、レビューするとき共通

  • トピックブランチの名前
    • Redmineのチケット番号を含めたか
  • マージ先のブランチ
    • 間違えていないか
  • 各コミットメッセージ
    • Redmineのチケット番号を含めたか
    • 「なぜ」そうしたのかを書いたか
      • 「〜から」「〜ため」
  • 1コミットがアトミックな塊になっているか
    • どのコミットの状態にHEADを移動してもテストが通るか
  • コミットが大きすぎないか
    • レビューするひとの負担にならないか
  • PR自体が大きすぎないか
    • レビューするひとの負担にならないか
  • 余計な変更がコミットに含まれていないか
    • インデント直したとか、末尾の空白を取り除いたとか、軽微なものでも含めてしまっていないか
  • コーディング規約に沿っているか
  • 「Files Changed」の方にコメントすると、修正コミットが「push -f」で上書きされても「x outdated」という形で参照できるので、残したいときはそちら

難しいと思ってること

  • 表示されるのは追加または変更があった差分だけなので、それ以外の他の箇所で修正が必要かどうか、というのはリポジトリ全体を把握していないと気づきにくい


思い出したら書き足す。