✔️

【コードレビュー】レビュワーが意識していること

2023/01/31に公開

1. 完璧を求めすぎない

  • 以下の項目は最低限チェックする
    • ビルドエラー起こしていないか
    • 設計がプロジェクトの指針に沿っているか
    • 命名規則は適切か
    • 今は使っていない、将来使うかもしれないコードが入ってないか
  • 致命的でない箇所は、imoやnitsを使って、修正するしないは実装者の判断に委ねるようなコメントをする(以下、参考サイト)

https://qiita.com/kamihork/items/be0d7bdad8ae5a8082fb

2. レビュー依頼されたら、翌日までにレビューする

  • 実装者にコンテキストスイッチが発生するため
  • そのためには、すぐにレビューできる状態を作ることが必要。
  • レビュー量にもよるが、レビュー箇所が多くなりそうな時は実装者と同期しながらレビューする

3. コードレビュー = 「粗探し」に近いということを忘れない

  • 以前指摘して改善されたコードがあったら👍 などのリアクションをつける
  • 気持ちを表現するためにコメント内に絵文字を積極的に使う

4. 根気よく同じ内容も指摘する

  • (特に新卒エンジニアに対してだが、)「前も同じこと言いましたが〜」というのはなるべく言わないようにする

参考サイト

https://zenn.dev/nasa/articles/496a475148cedc

Discussion