エンジニアのためのスキルアップ勉強会_1_妥協しないコードレビュー_.pdf

Transcript

1. ソニックガーデンジムに参加してコードに対する向 き合い方が変わった話 @エンジニアのためのスキルアップ勉強会#1 「妥協しないコードレビュー」 2023/12/11
2. 目次 1. 自己紹介 2. ソニックガーデンジムに参加した経緯 3. 何を学んだか 4. 心境の変化 5. 自分なりの「妥協しないコードレビュー」 6. まとめ
3. 自己紹介 ・ソニックガーデンジム 7期生 ・プログラマー歴2~3年 ノボです @Nobo02149847 Webアプリケーション開発をしてます。 沖縄在住。
4. よろしくお願いします
5. 今日はソニックガーデンジムに参加してコードに対する向き合い方が変わったことにつ いて話します。 参考になる人： ・コードレビュー怖いなって思っている人。 ・ソニックガーデンジム気になるなと思っている人。 何を話すのか
6. 目次 1. 自己紹介 2. ソニックガーデンジムに参加した経緯 3. 何を学んだか 4. 心境の変化 5. 自分なりの「妥協しないコードレビュー」 6. まとめ
7. 仕事でコードを書いて2~3年目になり、コードを書くのに慣れてきたが、もっと良いコード の書き方が知りたい。 何か良い方法はないかな...🤔 知り合いの紹介で「ソニックガーデンジム」を知った。 ソニックガーデンジムに参加した経緯
8. これだ！！💪
9. 応募　→　参加できることになった。 3ヶ月間で課題に沿ったアプリケーションを開発することに。💪 ソニックガーデンジムに参加した経緯
10. 目次 1. 自己紹介 2. ソニックガーデンジムに参加した経緯 3. 何を学んだか 4. 心境の変化 5. 自分なりの「妥協しないコードレビュー」 6. まとめ
11. ・レビューし易いように工夫する ・気になることは質問する ・他人のレビューを見てみる 何を学んだか
12. レビューし易いように工夫する ・PRのサイズが大きくならないように気を付ける。機能ごとの区切りで出すのが　分かり やすい。 ・コメントにはアノテーション（TODO, FIXMEなど）をつけて言い訳を書く。 ・UIの変更があれば変更箇所の動画を添付する。 ・Linterを使用する。またセルフレビューを行い、レビューの本質でない箇所を　レビュー させないようにする。
13. 気になることは質問する コードレビュー初期にやりがちだったコメント レビュワー：この実装はAが良いのでは？ 私：　　　　Aが良いと思います！Aで実装します。 なぜ実装Aが良いのか理解してないまま実装してしまう。 応用が効かなさそう。
14. 気になることは質問する コードレビューに慣れてきた頃 レビュワー：この実装はAが良いのでは？ 私：　　　　Bの理由があるのでこの実装にしています。Aの実装にする理由はC　　　　　　 だからでしょうか？ レビュワー：Aの実装にする理由はCではなくDだからです。 私：　　　　理解しました。その理由であればAの実装が良いと思います。Aの実　　　　　　 装をします。 実装Aを選択する理由が理解できているので応用が効きそう。
15. 他人のレビューを見てみる ・他人のPRの見ることで、自分が指摘されなかったことや、別の実装方法を学ぶ　こと ができる。 自分へのレビューでなくても学ぶことができる
16. https://techbookfest.org/product/wsrsXmV6u0q7hB5F0yt49C?productVariantID=e1UcMVjnwJUx2hy8nxMZTt
17. 目次 1. 自己紹介 2. ソニックガーデンジムに参加した経緯 3. 何を学んだか 4. 心境の変化 5. 自分なりの「妥協しないコードレビュー」 6. まとめ
18. ソニックガーデンジムに参加する前の心境 ・この実装がベストかどうか分からない。 ・理解できないコメントがきたらどうしよう。 ・コメントが多すぎたらへこみそう。 ・コードレビューは必要だけど、最低限あれば良い。 ・正直、コードレビュー怖い。
19. ソニックガーデンジムに参加中の心境 ・コメントいっぱいきた。へこむ。（レビューコメント89） ・コメントが優しい...！？ ・流派とかあるのか。面白い。 ・綺麗なコードの書き方を知れる。楽しい。 ・コードレビューは絶対必要なのでは...！！
20. ソニックガーデンジムを終了後の心境 ・コードレビューを受けて成長を実感。 ・レビュワーとの仲が深まった気がする（多分） ・コードレビュー怖くなくなった。むしろコードレビューがないと怖い。
21. 正直、コードレビュー怖い ↓ コードレビュー怖くなくなった。むしろレビューがないと怖い。 心境の変化をまとめると...
22. 目次 1. 自己紹介 2. ソニックガーデンジムに参加した経緯 3. 何を学んだか 4. 心境の変化 5. 自分なりの「妥協しないコードレビュー」とは 6. まとめ
23. 　　　　　　「妥協しないコードレビュー」とは...　何？　🤔 自分なりの「妥協しないコードレビュー」とは
24. 「妥協したコードレビュー」を考えてみる。🤔 ・命名規則がバラバラ ・シンプルでない実装 ・よく分からないコメント ・使用しているのか分からないメソッド、ファイル ・メンテナンスコストだけが増える効果の低いテスト 自分なりの「妥協しないコードレビュー」とは
25. 「妥協しなかったコードレビュー」を考えてみる。🤔 ・命名規則が統一されている ・シンプルで読み易い実装 ・意味のあるコメント ・使用しているのか分からないメソッド、ファイルが存在しない。 ・効果のあるテスト 自分なりの「妥協しないコードレビュー」とは
26. 「妥協しなかったコードレビュー」の方が良いプロダクトになりそう ↓ 「妥協しないコードレビュー」とは良いプロダクトに作るために必要な共通認識 自分なりの「妥協しないコードレビュー」とは
27. 目次 1. 自己紹介 2. ソニックガーデンジムに参加した経緯 3. 何を学んだか 4. 心境の変化 5. 自分なりの「妥協しないコードレビュー」 6. まとめ
28. ソニックガーデンジムを通して ・レビューし易いように工夫する ・気になることは質問する ・他人のレビューを見てみる ・コードレビュー怖くなくなった。むしろレビューがないと怖い。 ・「妥協しないコードレビュー」で良いプロダクトを作ることができる。 まとめ
29. ご清聴 ありがとうございました