Skip to content

Instantly share code, notes, and snippets.

@kaminotsukai
Last active May 31, 2022 08:27
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save kaminotsukai/2a14773923efa97eb9b76e87add3a473 to your computer and use it in GitHub Desktop.
Save kaminotsukai/2a14773923efa97eb9b76e87add3a473 to your computer and use it in GitHub Desktop.

コードレビュー

レビューの目的はコードベースとプロダクトの品質を維持すること

観点(設計・機能・複雑さ・テスト・命名・コメント)

  • そのコードは設計が良く、システムに適しているか?
  • コードは作者が意図した通りに動作しているか?
  • 他の開発者が将来このコードに出会ったとき、簡単に理解して使用することができるか?
  • コードに適切なユニットテストが存在するか?
  • 適切な命名がなされているか?
  • 会社独自の注意事項を守っているか?

コミュニケーション

  • 変更がある場合は、変更理由と代替案を提示する
  • 意図が不明瞭な時は理由を聞く
  • 依頼が来たらすぐにレビューを行う(24時間以内に終わらない場合はいつまでに終わるか連絡する)
  • 実装してくれたことに感謝する
  • コメント
    • Must:対応必須
    • Want:できれば
    • Nit:改善可能な点だが改善するか否かは作者に委ねる
    • Imo:私の意見では
    • FLY:参考までに
  • 人を辱めない(最善を尽くしている前提)
  • ネガティブな言葉は使わない(人をうらまず、コードを恨む)
  • どちらでもいいことについて決着をつけようとしない

レビューイ

  • より早く、より完全にレビューされる
  • レビュアのブロッキングを短くできる
  • リジェクトされた場合でも、作業の無駄が少なくて済む
  • より簡単によい設計が行える

リファクタリングは分割する

参考

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment