コードより先にコミットメッセージを書く

これは、フィヨルドブートキャンプ Advent Calendar 2021（Part 1） 13日目の記事です。 未経験からフィヨルドブートキャンプでプログラミングを勉強し、2021年3月から Tebiki 社でエンジニアとして働いている masuyama13 です。 入社当初、PR（プルリクエスト）を作成する際にコミットの整理に毎回かなり時間がかかるのが悩みでした。試行錯誤の結果、この悩みを解消することができたので紹介します。 それが、コードより先にコミットメッセージを書くという方法です。 コミットメッセージを先に書くやり方まず、タスクを分解して TODO リストを作ります。これから作業する内容がイメージできたら、コミットメッセージを一つ考えます。エディタなどにコミットメッセージを入力します。コミットメッセージが書けたら、それを常に意識しながらコーディングを進めます。作業中にコミットメッ

[udzura]

自力でたどり着いたのがまずすごい。これが発展すると、「コードより先にDesign Docを書く」などに行きつきそう。

[send]

一つの良いやり方だと思うけど、脇道に逸れることで生まれるものもあるので、この辺のバランスがいつも難しいなと思ってる

[stakme]

wipコミット60回くらいして、おもむろにソフトリセットして歴史を作り直して、きれいな歴史をリベースしてPR出して3分後には全部忘れる

[stefafafan]

テストファーストと似たところを感じる

[shimajimatsukushi]

入社からの実体験と改善の変遷が見れて参考になる。「コミットメッセージを先に書く」良さそう。

[kasuke18]

“コードを書く前に自分のやることが明確になっているので、作業中に脇道にそれたり無意識的に別の作業を始めてしまったりすることがなくなりました。”

[programmablekinoko]

これは目的の明確に非常に有用だね。”CMDD"（コミットメッセージ駆動開発）とでも言うのだろうか。

[NOV1975]

まず仕様書を書きますって話だよね？その手段がコミットメッセージってだけで。

[BlueSkyDetector]

Amazonの製品開発前にプレスリリース文から書き始めるってやつみたいだ

[shinagaki]

最初にスコープを決めておくのは重要かも

[MtAsuka]

それはタスク/案件管理をする何かに書くべきことであって、コミットにはあまり意味を持たせない方がいいと思う。

[kubecorn]

テスト駆動と同じ観点かと思ったけど、コミットコメントなら"今回はここまでやる"っていう確認にもなっていいかも。

[aki03]

「今こうやってるよー」も良いのだけれど、これまでの試行錯誤・変遷がまとまっているのが良い。

[ducktoon]

git now から即 push でええやん

[nakag0711]

まあ元に戻せることがこの手のシステムを使う意義の第一なんで、あまりコミットの綺麗さにこだわりすぎない方が

[tor4kichi]

ポモドーロ・テクニックが時間に対する意識付けならば、コミットメッセージ先行で作業するのはタスクに対する意識付けと言えそう。

[tsimo]

テスト駆動開発でも同じ効用が得られそう。

[xzone]

仕様（目的）を明確にしてからコード書けってことで。

[satosssi]

修練を感じ取れる良い記事のタイトル

[koogawa]

“コードを書く前に自分のやることが明確になっているので、作業中に脇道にそれたり無意識的に別の作業を始めてしまったりすることがなくなりました” なるほど

[tettekete37564]

いまいち上手くいっていない新人にやってみて貰うのには良いかも

[l__LINE__l]

コメント派

[knok]

やることをブレークダウンしたメモをコメントに書いていたけど、コミットログとして使える文言で書くというのはありかもしれない

[iga_k]

なるほどー！試行錯誤の様子も書いてあってめっちゃ知見。

[mayumayu_nimolove]

へー、こんなやり方もあるんだな。私はできないけど。すぐ方針変わるからw

[shiba_yu36]

よい

[ryouchi]

「コードを書く」以外に置き換えても応用できそーだなー “コードを書く前に自分のやることが明確になっているので、作業中に脇道にそれたり無意識的に別の作業を始めてしまったりすることがなくなりました”

[t-murachi]

CMDD? (コミットメッセージドリブン開発)

[otchy210]

コミットメッセージを先に書くことはしてないけど、意識の中ではこれに近い感じ。最小ステップを実装→テスト→リファクタ→コミット→次のステップへ。って感じ。余裕のある時は。時間が無いとまとめがち…。

[yasu-osu]

作業の先にあるゴールを意識することで目の前の行動が変わるという好例ですね。

[waihasaruya]

感謝のコミット。ある日、コミットメッセージがコードを置き去りにした。みたいな話かと思ったが違ったのか良く分からん

[xxxxxtttttt]

確かに開発の最終的な単位はコミットになるから整理されていいやも

[peketamin]

なるほろー！

[kvx]

ありだ

[kuwayoshi]

おもしろい

[dominion525]

よい習慣だと思います。

[UKIBORI]

これは良さそう。ついつい次の作業に入っちゃうんだよね、、いっその事ことエディタの背景にデカデカと表示させたい