Gitで作業していると、最初は「ブランチを切る」「コミットする」「プッシュする」くらいは理解できているつもりでも、実際に複数のブランチをまたいで作業し始めると一気に難しくなる。
特に、自分は以下のような問題にぶつかった。
- クラス単位で細かくブランチを切りすぎた
- 未コミット変更を持ったままブランチを移動していた
- stash / switch / stash pop を繰り返してワークツリーがぐちゃぐちゃになった
- 下位ブランチの修正を上位ブランチへ反映し忘れて、Pull Request の差分が意図しないものになった
この記事では、その反省と、どう進めればよかったのかを整理する。
ブランチの切り方の反省
当初、以下のようにクラスごとにブランチを切っていた。
feature/Card
feature/Shoe
feature/HandOfCards
feature/Player
feature/Game
一見すると、細かく分けられていて良さそうに見える。
しかし実際には、それぞれのクラスは強く関係し合っている。
例えば以下のような状態になる。
Card がないと Shoe が作れない
HandOfCards がないと Player が作れない
Player や Dealer がないと Game が作れない
つまり、ブランチ同士が依存しすぎていた。
この状態だと、あるブランチで作業している途中に、別のブランチで作ったクラスを修正したくなることが多発する。
例えば feature/Game で作業しているときに、feature/Card のメソッドが足りないことに気づく、というような状況である。
クラス単位ではなく、機能単位でブランチを切るべきだった
ブランチは「クラス」ではなく、「機能」や「動く単位」で切るべきだった。
今回の場合、ブラックジャックのアプリを作成していたので、ブラックジャックが動くという1機能がを1ブランチにして良いと先輩に教えていただいた。
そんなに大きい単位を1ブランチとして考えていいのか!と驚いたところではあったが、冷静に考えると1つの機能と言えるなと感じた。
ブランチを切るときは、以下のように考えるのがよい。
このブランチの変更によって、何ができるようになるのか?
未コミット変更を持ったまま作業していた
もう一つの大きな問題は、未コミット変更を長く持ったまま作業していたことだった。
当時は、以下のように考えていた。
ワークツリー上でどれだけ修正しても、
コミットするまではそのブランチの変更にはならない。
だから、今の作業が終わったあとに、
対象のブランチへ移動して、
必要な変更だけコミットすればよい。
これは半分正しい。
たしかに、コミットするまではブランチの履歴には入らない。
しかし、未コミット変更は「今いるブランチ専用の安全な箱」に入っているわけではない。
未コミット変更は、単にワークツリー上に存在している変更である。
そのため、未コミット変更を持ったままブランチを移動できてしまう場合がある。
例えば、以下のようなことが起きる。
feature/Game で作業する
↓
未コミットのまま feature/Card に移動する
↓
feature/Card 上で commit する
↓
Game用の変更が Cardブランチに入ってしまう
つまり、
作業したブランチ = その変更が所属するブランチ
ではない。
実際には、
コミットした瞬間にいたブランチ = その変更が所属するブランチ
になる。
ここを曖昧にしたまま作業すると、変更がどのブランチのものなのかわからなくなる。
ブランチを移動できるときとできないときがある
未コミット変更を持ったままブランチを移動しようとすると、以下のようなエラーが出ることがある。
error: Your local changes to the following files would be overwritten by checkout:
xxx.php
Please commit your changes or stash them before you switch branches.
これは、ブランチを切り替えることで、今の未コミット変更が上書きされる危険がある場合に出る。
一方で、未コミット変更があってもブランチ移動できる場合もある。
これは、Gitが「この変更は移動先ブランチに切り替えても上書きされない」と判断した場合である。
ただし、エラーが出ないから安全というわけではない。
Gitとしては「変更が消えないから移動してもよい」と判断しているだけで、人間側の作業としては、別ブランチ用の変更が混ざる危険がある。
stash を多用してワークツリーがぐちゃぐちゃになった
未コミット変更を持ったままブランチ移動できない場合、自分は以下のような作業を繰り返していた。
未コミット変更を stash する
↓
対象のブランチに switch する
↓
stash pop する
↓
commit する
↓
push する
短時間であれば、このやり方でも問題ない場合がある。
しかし、長期的に未コミット変更を持ちながらこの作業を繰り返すと、以下のような問題が起きる。
stash に入れていることを忘れて、同じような実装をもう一度してしまう
stash pop した変更差分が、別ブランチの内容と混ざる
今の変更がどのブランチ由来なのかわからなくなる
どの変更が push 済みなのかわからなくなる
stash は便利だが、あくまで一時退避のための仕組みである。
長期間の作業保存や、複数ブランチをまたぐ作業管理の中心にすると、状態を見失いやすい。
積みブランチでは、下位ブランチの修正を上位ブランチへ反映する必要がある
複数のブランチが以下のように段階的に積まれているとする。
main
└─ feature/Card
└─ feature/Character
└─ feature/HandOfCards
└─ feature/Game
この構成自体は悪いわけではない。
いわゆる stacked branches / stacked Pull Request のような形で、下位ブランチの変更を前提に上位ブランチを作ることはある。
ただし、この場合は、下位ブランチを修正したら上位ブランチにも順番に反映する必要がある。
例えば、feature/Card を修正したら、以下の順で反映する必要がある。
feature/Card
↓
feature/Character
↓
feature/HandOfCards
↓
feature/Game
これを忘れると、Pull Request の差分に意図しない変更が含まれる。
例えば、feature/Game から feature/HandOfCards に Pull Request を出している場合を考える。
feature/Card の修正を feature/Game にだけ直接取り込むと、feature/HandOfCards にはその Card の修正が存在しない。
その結果、GitHub 上では以下のように見える。
feature/HandOfCards にはない
feature/Game にはある
そのため、feature/Game の Pull Request に Card の変更差分が表示されてしまう。
これを防ぐには、下位ブランチから上位ブランチへ順番に反映する必要がある。
WIPコミットという考え方
stash の代わりに、WIPコミットを使う方法がある。
WIP は Work In Progress の略で、作業途中の状態を一時的にコミットする運用である。
例えば、以下のように使う。
git add .
git commit -m "WIP: implement game flow"
これは特別なGitコマンドではない。
技術的には普通のコミットである。
ただし、目的は「完成した変更を記録すること」ではなく、「作業途中の状態を安全に保存すること」である。
stash との違いは以下である。
stash
- 作業途中の変更を一時退避する
- ブランチの履歴には残らない
- stash list を見ないと存在を忘れやすい
- stash pop するブランチを間違えると混ざりやすい
WIPコミット
- 作業途中の変更をブランチの履歴に保存する
- git log で確認できる
- どのブランチの作業なのかが明確になる
- 後で reset や rebase で整理できる
WIPコミットを使った作業例
以下のようなブランチ構成があるとする。
main
└─ feature/Card
└─ feature/Character
└─ feature/HandOfCards
└─ feature/Game
feature/Game で作業中に、feature/Card を修正したくなったとする。
まず、今の作業を feature/Game に WIPコミットとして保存する。
git switch feature/Game
git status
git add .
git commit -m "WIP: implement game flow"
これで、feature/Game の作業途中変更は feature/Game の履歴に入る。
次に、feature/Card に移動する。
git switch feature/Card
Card.php を修正する。
# Card.php を修正する
git add .
git commit -m "Add card score helper"
git push
その後、間のブランチを順番に更新する。
git switch feature/Character
git merge feature/Card
git push
git switch feature/HandOfCards
git merge feature/Character
git push
git switch feature/Game
git merge feature/HandOfCards
git push
このように順番に更新することで、上位ブランチの Pull Request に意図しない差分が出ることを防ぎやすくなる。
WIPコミットは最終的に整理する
WIPコミットは、基本的にそのまま Pull Request に出すものではない。
作業途中の保存用コミットなので、最終的には正式なコミットに整理する。
例えば、直前の WIPコミットを取り消して、中身だけワークツリーに戻すには以下を実行する。
git reset HEAD~1
このコマンドは、直前のコミットを取り消す。
ただし、変更内容は消えずにワークツリーに残る。
その後、追加修正を行い、正式なコミットとして作り直す。
# 追加で修正する
git add .
git commit -m "Implement game flow"
これにより、以下のようにできる。
WIP: implement game flow
という一時的なコミットを消して、
Implement game flow
という正式なコミットに作り直せる。
もし WIPコミットが直前にあり、その後の追加修正もまとめて同じコミットにしたいだけなら、以下のように --amend を使う方法もある。
git add .
git commit --amend -m "Implement game flow"
ただし、複数の WIPコミットがある場合や、コミットの順番を整理したい場合は、git rebase -i を使って整理することもある。
今回の反省
今回の問題は、単に Git コマンドを知らなかったことだけではない。
より大きな問題は、以下を曖昧にしたまま作業していたことだった。
今、自分はどのブランチにいるのか
この変更はどのブランチに入れるべきなのか
このブランチはどのブランチを親にしているのか
Pull Request の base はどこなのか
下位ブランチの変更を上位ブランチに反映できているのか
未コミット変更を持ったままブランチを移動したり、stash / stash pop を繰り返したりすると、こうした関係が見えにくくなる。
その結果、以下のようなことが起きる。
変更の所属先がわからなくなる
stash したことを忘れる
別ブランチの変更と混ざる
Pull Request に不要な差分が出る
履歴が見にくくなる
まとめ
今回の学びは、以下である。
- ブランチは「何ができるようになるか」で切る
- 未コミット変更を持ったままブランチをまたぐと、変更の所属が曖昧になる
- stash は便利だが、長期的な作業管理には向かない
- WIPコミットを使うと、作業途中の状態をブランチの履歴として保存できる
- 積みブランチでは、下位ブランチを修正したら上位ブランチへ順番に反映する
- WIPコミットは最後に reset や amend などで正式なコミットへ整理する
Git操作で大事なのは、単にコマンドを覚えることではない。
今どのブランチにいるのか
この変更はどのブランチのものなのか
どのブランチをbaseにPull Requestを出すのか
を常に意識することだと感じた。
最後まで読んでいただきありがとうございます。このしくじりが参考になれば嬉しいです。