Edited at

コードレビュー 6か条

More than 1 year has passed since last update.


謝辞

コードレビューを1から教えてくれた現場に敬意を。


1.コメントには重みをつけろ


  • 重みのないコメントは相手にストレスを与えていると思え


    • must > should > nits > imo > ask


      • askは特殊だと思うけど使いやすかったので記載






2.些細な指摘(imo/nits)は5つ以内


  • 本当に修正してほしい指摘を埋もれさせない

  • 数を限定することで、レビュイーのコメントクオリティを担保

  • どうしようもないコードに慈悲はないので除外


3.論理的に説明できないのであれば指摘しない


  • 原則書き手を尊重せよ

  • 己の美的感覚で指摘をするな


    • 論理的でない美的感覚は百害あって一利なし

    • どうしてもやりたければチームでルール化せよ



  • 1分理解5分反映を意識する


    • 修正コミットを直接積むのも良いだろう

    • ペアプロも良いだろう




4.コメント全部に対応しない


  • 理解できないコメントは無視で良い

  • 無視されてストレスに感じるなら、コメント全てが悪いと思え


    • 重みを変える

    • 説明を変える

    • ペアプロする

    • 直接話をする



  • その指摘は常に正しくないと思え


    • 自分は常に正しくないと知れ




5.一回のレビューで終わらせろ


  • 修正->コミット->修正の無限ループを悪だと思え


    • 無限ループはレビュアーを疲弊させる

    • チームの雰囲気も悪くなる




6.approve or +2 されたら即マージしろ


  • ユーザーへ素早く価値を届けろ

  • マージされないことによるレビュアーのストレスを排除せよ

  • マージを恐れない


    • revertがある



  • マージできない理由を述べよ



参考文献

デキるプログラマだけが知っているコードレビュー7つの秘訣


最後に

ええ、あなたの想像の通りです。ただの私の愚痴でした。

お付き合いありがとうございました。