20240511 ひまプロによる駆け出しエンジニア向けLT会 発表資料

2024/5/11に開催された、ひまプロによる駆け出しエンジニア向けLT会＆公開収録 vol.2にて、LT会で発表した資料です。
https://teamhimapro.connpass.com/event/312314/

Transcript

1. 【開発工数1/4に削減！】 コメントファーストの開発方法 @masafumi330 1/11
2. 自己紹介 - masafumi330 - TuneCore Japan (2022年~現在) - バックエンドエンジニア (Go) - 熊本出身 - 妻と二人暮らし - 趣味：筋トレ、Netflix - 最近よく聴くアーティスト - Dua Lipa - Lauv - X(Twitter): @masafumi330 この写真は妻が撮ってくれました！ 2/11
3. TuneCore Japan 3/11
4. こんなシーンないですか？ - Pull Request レビューでレビュー修正のコメントが積み重なる - 実装途中で方針が何度も変わってしまう - 実装漏れ、仕様漏れが起きてしまう 4/11
5. どうすればいい？ 5/11
6. 真っ先にコメントを書いたPull Requestを出すのです！ 6/11
7. コメントを書いていく - 既存コードリーディングしながら、実装していく箇所にコメントを書いていく - 何を取得するのか？条件分岐は？処理の流れは？ - 新規ファイル作成、I/F、関数やメソッドのシグネチャ ex.) // TODO: // - ここで XXX を取得 // - もし YYY であれば YYY // - それ以外は ZZZ ex.) // TODO: // - valid // - ドメインオブジェクトを生成 // - 永続化 // - response 7/11
8. Pull Requestの作成 - Descriptionにレビュー観点として「方針の確認」を記載 - ex.) ざっくり実装の概要を TODOで書いていますが、方針問題ないか確認お願いします！ - レビュワーをアサインしてレビュー依頼 8/11
9. 効果 - レビュワーとの認識の齟齬が無くなる - コメントを書いていく中で考慮漏れに気づく - 詳細実装に入った際、迷いなく開発が進むので、爆速で実装が終わる 実際この方針に変えたところ。。。 開発工数が 1/4 ほどまで削減できました！ 9/11
10. まとめ - 実装量が多くなりそう、複雑度が高そうな開発だと感じたら、 まずはコメントで実装方針を書いてみる - コメントで先に方針を固めておくことで、開発工数の削減、 考慮漏れのミス、仕様の確認をすることができる - 迷いなくコーディングを進められることが気持ちいい！！！ 10/11
11. ご清聴ありがとうございました！ https://www.tunecore.co.jp/jobs チューンコアジャパンではエンジニアを募集しています。 11/11