俺たちはなぜコードレビューをするのか

Transcript

1. 俺たちはなぜコード レビューをするのか 2024-03-29 小池 大地 【KURAND社 協賛】仕事とお酒を愛でる「ソース コード」レビューまつり！
2. こんにちは - 小池 大地 - 面白法人カヤック 人事/サーバサイドエンジニア Go で Web app を書いたり Terraform で AWS のインフラ構築したり - 好きなお酒 麦焼酎
3. レビューしてますか？
4. https://chat.openai.com/share/f1758a92-6088-48a2-bf4a-42c359b42fc5 コードレビューの目的(GPT-4)
5. コードレビュー（英: code review）は、ソフトウェア開発工程で見過ごされた 誤りを検出・修正することを目的としてソースコードの体系的な検査（査読）を 行う作業のこと。 https://ja.wikipedia.org/wiki/%E3%82%B3%E3%83%BC%E3%83%89%E3%83%AC%E3%83%93%E3%83%A5%E3%83%BC コードレビューの目的(Wikipedia)
6. まあわかる でもレビューじゃなくても 良いものもない？
7. - レビュアーがどれだけ真剣にレビューしても全部のバグを発見はできない - 実装が妥当かどうかはユースケース(どのように使われるか)によって決定さ れるので、コードだけ見ても分からない場合が多い 例: 名前を入力するフォームのバリデーション ひらがな/カタカナ - 実装者もレビュアーも全員ドメイン知識に精通しているとは限らない - Pull Request マージ後の E2E の動作確認や QA でもバグを検出することが できる 品質(バグ)
8. 学習と成長 - モブプロやペアプロといった手段がある - レビューは成果物に対して行うので思考や実装の過程は分からないが、モブ プロやペアプロであればこの過程を体験できる。特に初学者のメンバーに対 してはこちらのほうが良いと感じる - ちょっとしたリファクタリングや管理画面の改修などをお題にして行うと ちょうどよい。終了後はそのままマージすることも可能
9. レビューの目的とされてい るものは代替手段があるこ とが多い
10. ではなぜレビューするのか
11. https://chat.openai.com/share/f1758a92-6088-48a2-bf4a-42c359b42fc5 コードレビューの目的(GPT-4)
12. 保守するから
13. - 実装者以外のチームメンバーがそのコードをメンテナンスできることを合意 するため - 2~3年も運用すればビジネスの要求が変化していき、初期のアーキテクチャ や機能では想定していない改修が発生する - ビジネスの要求と、ビジネスを継続していく中で変化していく要求にアプリ ケーションが応えられなければならない。この状態を維持することが人間に よるレビューの目的 なぜレビューするのか
14. - 設計 - アーキテクチャ、モジュール、レイヤ、関数など - 設計を誤ると後続の実装がすべてつらくなる - 良い設計になっていれば実装が誤っていても後から修正しやすいし、要求の 変化にも対応しやすい - 設計を終えたビルドや CI が通らない状態で一旦レビューをすることもあ る。実装まで終えた状態だと設計に見直しが入った場合に大きな手戻りが発 生し逆に工数がかさむことがある。大きな実装の際に有効 何をレビューするのか
15. 保守しない前提ならレ ビューは必ずしも必要では ないのでは？
16. - 短期のキャンペーンサイトの開発など、保守運用を前提としていない開発 - もちろんレビューできるならレビューしたほうがいいが工数は無限にあるわ けではない。感覚的には実装工数が2時間ぐらいのものは30分近くレビュー に必要。負担になるとレビューが雑になり、レビューすることが目的となり がち - シンプルなエンティティの CRUD 操作のような振る舞いが明確で後の工程で 不具合として検出しやすいもの - 管理画面など、システムの信頼性の低下をある程度許容できるもの レビューを省略できる可能性があるもの
17. レビューしてますか？
18. - バグになりうるコードを検出する linter - go vet と staticcheck https://staticcheck.dev/ - linter と統合して動き自動レビューをする reviewdog 🐶 https://github.com/reviewdog/reviewdog - credentials のリポジトリへのコミットを防ぐ git-secrets https://github.com/awslabs/git-secrets ツール
19. 酒とゲームとインフラとGCP 『ゲームインフラ』をキーワードに お酒を飲みながら Google の技術を楽しむ 次回 7/5 (金) SQUARE ENIXさん会場 https://sake-game.connpass.com/event/312225/
20. ありがとうございました