エンターテイメント!!

遊戯王好きのJavaエンジニアのブログ。バーニングソウルを会得する特訓中。

【翻訳】The 6 key questions I ask when reviewing code

元記事

The 6 key questions I ask when reviewing code - DEV Community

経緯

ちょっと興味を惹かれたので、翻訳してみた

要点

コードレビューでするべき質問・確認すべき内容

  1. 変更理由の説明
  2. 変更内容の副作用の検証(要求以外の挙動をしないかの検証)
  3. 影響範囲
  4. エンドユーザー・運用者からの視点
  5. いつ実行されるか?
  6. 要件がすべて満たされているか?

指摘は、否定的なものになりがち。
肯定的なコメントを残せるなら残す。

感想

書かれると当然だが、文章化してみたことは、ほとんどないなと思った。

業務をやっていって、なんとなく覚えたけど、初学者は分からんだろうなと思う。
対面あり/なしにかかわらず、する側もされる側も、これに注視して説明が必要だろうとは思う。

特に対面だと、レビューイとレビューアで、前提が違っていると、空回りすることが多い。
コーディング規約があるのなら、レビュー規約も作って、円滑にレビューが進むようにすべきだと思いました。