gitmessageを使って丁寧に開発しよう

Transcript

1. .gitmessage を整備しよう unagi_dog(@NAUS3E / @phnyo) .gitmessage を整備して虚無コミットログをやめよう .gitmessage を整備して虚無コミットログをやめよう 1 1
2. コミットの話 .gitmessage を整備して虚無コミットログをやめよう .gitmessage を整備して虚無コミットログをやめよう 2 2
3. コミットってなに？ 超ざっくりいうと git というバージョン管理ツールで 現在のファイルの状態を保存しておくこと .gitmessage を整備して虚無コミットログをやめよう .gitmessage を整備して虚無コミットログをやめよう 3 3
4. コミットってなに？ コミットの嬉しさ 1. なんかやばくなったときに戻せる 2. 他人が見て変更を追える .gitmessage を整備して虚無コミットログをやめよう .gitmessage を整備して虚無コミットログをやめよう 4 4
5. コミットログ コミットするときにログを書く "initial commit" " 記事が読みにくいのでh1 をh2 にした" " うに" 虚無コミットログ => 変更についての情報がないログ .gitmessage を整備して虚無コミットログをやめよう .gitmessage を整備して虚無コミットログをやめよう 5 5
6. 虚無コミットの例 .gitmessage を整備して虚無コミットログをやめよう .gitmessage を整備して虚無コミットログをやめよう 6 6
7. なにがだめ？ hi -> 意味不明 hi2 -> 意味不明 nyaos -> 「進捗ダメです」の隠語 これを他人が追える？ => 無理 .gitmessage を整備して虚無コミットログをやめよう .gitmessage を整備して虚無コミットログをやめよう 7 7
8. 適切な情報量のコミットログ .gitmessage を整備して虚無コミットログをやめよう .gitmessage を整備して虚無コミットログをやめよう 8 8
9. a.c の関数とb.c の関数とc.c の関数とd.c の関数とe.c の関数と... a.c の関数では... b.c の関数では... c.c の関数では... d.c の関数では... がんばりました！ => わからん！ .gitmessage を整備して虚無コミットログをやめよう .gitmessage を整備して虚無コミットログをやめよう 9 9
10. なにがだめ？ ファイルの変更が多すぎ！ ファイルの変更が多すぎるとどこで何を変更したかわからなくなり がち コミットログが雑・意味がわからない 大体3 ヶ月くらい経つと自分が何考えてたか覚えてない 今回は後ろの話をします .gitmessage を整備して虚無コミットログをやめよう .gitmessage を整備して虚無コミットログをやめよう 10 10
11. （主観的に）いい例 ADD Code Template for Dijkstra's Algorithm ダイクストラ法のライブラリを整備した。 テストケース: [AOJ なんとか...] reference: [ サイトとか] .gitmessage を整備して虚無コミットログをやめよう .gitmessage を整備して虚無コミットログをやめよう 11 11
12. ほな何書けばいいの？ 実はベストプラクティスがある 形式的な話は参考文献見てね WHAT やWHY を書き、HOW を書かない のが大事 .gitmessage を整備して虚無コミットログをやめよう .gitmessage を整備して虚無コミットログをやめよう 12 12
13. なんで大事なの？ HOW= 実装はコードが十分表現してるはず。 WHY とかWHAT はプログラムを読むだけだと意味わからないがち => 何(WHAT) を、なぜ(WHY) ということを書くべき .gitmessage を整備して虚無コミットログをやめよう .gitmessage を整備して虚無コミットログをやめよう 13 13
14. （主観的に）いい例再掲 ADD Code Template for Dijkstra's Algorithm ダイクストラ法のライブラリを整備した。 テストケース: [AOJ なんとか...] reference: [ サイトとか] WHAT はある。WHY は性質上ない? .gitmessage を整備して虚無コミットログをやめよう .gitmessage を整備して虚無コミットログをやめよう 14 14
15. （主観的に）いい例再掲 ADD Code Template for Dijkstra's Algorithm ダイクストラ法のライブラリを整備した。 [[WHY を追加]] 理由: ダイクストラ法のライブラリがなかったため。 テストケース: [AOJ なんとか...] reference: [ サイトとか] WHY とWHAT を書いておくとコミットの意義がわかりやすい .gitmessage を整備して虚無コミットログをやめよう .gitmessage を整備して虚無コミットログをやめよう 15 15
16. コミットログを楽に書きたい .gitmessage を整備して虚無コミットログをやめよう .gitmessage を整備して虚無コミットログをやめよう 16 16
17. .gitmessage で認知コストを減らす コミットする際のテンプレート # でコメントアウトできる ガイドラインとかを書いておくと良い git commit -m ... ではなく git commit だけ .gitmessage を整備して虚無コミットログをやめよう .gitmessage を整備して虚無コミットログをやめよう 17 17
18. .gitmessage 自分のやつ（抜粋） SUBJECT (Under 50 chars) # Best subject line would fit in to this sentence perfectly: # If applied, this commit will (subject line) BODY (Under 72 chars per line) # What am I trying to achieve with this commit? [reference or tickets: #XXX] .gitmessage を整備して虚無コミットログをやめよう .gitmessage を整備して虚無コミットログをやめよう 18 18
19. 実際の表示例 .gitmessage を整備して虚無コミットログをやめよう .gitmessage を整備して虚無コミットログをやめよう 19 19
20. 個人開発でも気をつけよう 虚無をやめて有をしよう というかちゃんと後の自分にもわかるようなログを書こう .gitmessage を整備して虚無コミットログをやめよう .gitmessage を整備して虚無コミットログをやめよう 20 20
21. おわり 質問があればどうぞ 21 21
22. 参考文献 1. "How to Write a Git Commit Message" CBEAMS. 31 Aug. 2014, https://cbea.ms/git-commit/. visited 11 May. 2022 2. "Git のカスタマイズ - Git の設定" git scm, unknown, https://git- scm.com/book/ja/v2/Git- のカスタマイズ-Git- の設定. visited 11 May. 2022 .gitmessage を整備して虚無コミットログをやめよう .gitmessage を整備して虚無コミットログをやめよう 22 22