コミットメッセージ駆動開発

コミットメッセージ駆動開発とは、コミットメッセージに合わせてコードを書く開発手法であり、コーディングのシングルタスク化を促すことで生産性の向上を助けるプラクティスです。

---

リンク

2 ページ目
Twitter(X) @IzumiNoritaka
https://twitter.com/IzumiNoritaka

3 ページ目
Bing Image Creator
–Please create a pop and catchy illustration that says "Single-Tasking". Please use pastel colors with pink as the base color. Please use Japanese fonts with rounded corners.
https://www.bing.com/images/create/please-create-a-pop-and-catchy-illustration-that-s/1-6658fe2b99764c3f81b70cf0e64d7032?id=SWwkZIUxSdnRkClkAfAo7w%3d%3d&view=detailv2&idpp=genimg&thId=OIG3.iUXm6YRijvSgNRA5Ya1B&FORM=GCRIDP&mode=overlay

6 ページ目
Multitasking: Switching costs.
American Psychological Association, March 20, 2006
https://www.apa.org/topics/research/multitasking

Transcript

1. コミットメッセージ 駆動開発 June 3, 2024
2. Call me “Nori”. Noritaka IZUMI @IzumiNoritaka def Twitter(X): print(“多趣味のため貧困🥺💸”) 2
3. 3 私がコードを書く上で大事にしていること 出典 Bing Image Creator –Please create a pop and catchy illustration that says "Single-Tasking". Please use pastel colors with pink as the base color. Please use Japanese fonts with rounded corners. https://www.bing.com/images/create/please -create-a-pop-and-catchy-illustration-tha t-s/1-6658fe2b99764c3f81b70cf0e64d7032?id =SWwkZIUxSdnRkClkAfAo7w%3d%3d&view=detail v2&idpp=genimg&thId=OIG3.iUXm6YRijvSgNRA5 Ya1B&FORM=GCRIDP&mode=overlay
4. 「コーディングの各過程を直列に行う」こと • テストを書いている間はテストを書くことに集中する • 条件分岐を書いている間は条件分岐を書くことに集中する 4 コーディングにおける「シングルタスク」
5. 「コーディングの各過程を並列に行う」こと • 実装とリファクタを同時にやる • テスト実装中にテストツールの改善を行う 5 コーディングにおける「マルチタスク」
6. マルチタスクに関する調査 6 「一度に複数のタスクを行うと生産性が低下する」 「タスクの切り替え時間が全体の 40 % を占めることもある」 出典 Multitasking: Switching costs. American Psychological Association, March 20, 2006 https://www.apa.org/topics/research/multitasking
7. コーディングを シングルタスクにすればよい 7
8. 🤔 8
9. Git での開発は局所的にシングルタスクである 9 開発中は自分のブランチは枝分かれせず、まっすぐ伸びていく。 まるでシングルタスクのように。 出典：ぼく
10. コミットする内容を先 に決めればいいのでは …？🤔 10
11. コミットメッセージ駆動開発 (Commit Message Driven Development) 11 長いので「CMDD」って呼びましょ
12. CMDD 12 コミットメッセージに合わせてコードを書く開発手法であり、コーディングのシ ングルタスク化を促すことで生産性の向上を助けるプラクティス
13. CMDD の流れ 1. やることリストを作成する 2. コミットメッセージを書く（空コミットを積む） 3. コードを書く 4. コミットする（2. で積んだコミットを修正する） 5. プッシュする （2. ～ 4. は繰り返す） 13
14. 14 出典：ぼく
15. 15 CMDD をやってみる
16. 16 1. やることリストを作成する 手書きでもテキストファイルでも 初めから完璧でなくてもよい 実装中・昼寝中にも思いついたら その都度追記すればよい # 機能 A のバグ修正 - テストに仕様変更を語らせる - パラメータのバリデーションを追加（不足してるから # 機能 B の実装 - とりあえず空 API を作って 200 を返す - 固定レスポンスを返す - 本の在庫取得処理をユースケースへ - ユースケースで固定値を返す - 在庫を DB から取得するようにする - パターン増やしとか異常系、ここは後で考えるか～～～
17. 2. コミットメッセージを書く 空コミットを積む 17 git commit --allow-empty -m "[wip]fix(user): リクエス トの password フィールドがバリデーションから漏れていた ので追加したった" # --allow-empty で空コミットが可能
18. 3. コードを書く コミットメッセージに集中する 何か他のこと（コード関連）を思 いついても、やることリストに書 くだけにして、すぐ実装に戻る 18 if apple >= 100: if banana >= 100: if cherry >= 100: if dragon_fruit >= 100: do_lightning_talk() else: go_to_bed() else: go_to_bed() else: go_to_bed() else: go_to_bed() foo.py
19. 4. コミットする 最初の空コミットを修正する 19 git commit --amend --date "$(date)" # --amend で直前のコミットを変更 # --date でコミット時刻を変更
20. 5. プッシュする 作業が終わったらプッシュ git push 20
21. おつかれさまでした🎉 21
22. CMDD のメリット・デメリット 22
23. CMDD のメリット • コードを書いていて迷うことが少なくなる ◦ コミットメッセージが決まる →取り組むことが明確になる →思考が整理される • コードレビューがしやすくなる ◦ コミットメッセージが明確になる →コミットの粒度がある程度小さくなる →実装過程が鮮明になる 23
24. CMDD のデメリット • Pre-commit hook が多いと開発スピードが落ちる ◦ CMDD をやるとコミット回数が倍以上に →コミットに時間が取られる ◦ Pre-commit を空コミット向けに最適化しましょう • ブランチをそのままマージすると後々見にくくなる ◦ コミットメッセージが明確になると →コミット数が増えがち ◦ リベースやスカッシュマージをしましょう 24
25. まとめ 25
26. CMDD は • コミットメッセージを先に書き、コードを後で書く手法 • コミットメッセージの達成に集中することで、コーディングにおける生産性 の向上につながる • 誰でも簡単に実践できる 26
27. こんな人におすすめ • 調べる、考える以外の時間でコードを書く手が止まってしまう人 ◦ 今やろうとしていることをコミットメッセージに書く →思考が整理される • コミットメッセージを考えるのに 30 秒以上かかってしまう人 ◦ コミットメッセージに困ったら、コミットを見直さなければならない ←先にコミットメッセージを決めると楽 • 開発スピードが遅いのはスキルの問題だと思っている人 ◦ 自分の考えていることを言語化する習慣をつける →困ったときに判断がしやすくなる 27
28. 28 おわり