Upgrade to Pro — share decks privately, control downloads, hide ads and more …

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

phnyo
May 11, 2022
970

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

phnyo

May 11, 2022
Tweet

Transcript

  1. コミットログ コミットするときにログを書く "initial commit" " 記事が読みにくいのでh1 をh2 にした" " うに"

    虚無コミットログ => 変更についての情報がないログ .gitmessage を整備して虚無コミットログをやめよう .gitmessage を整備して虚無コミットログをやめよう 5 5
  2. なにがだめ? hi -> 意味不明 hi2 -> 意味不明 nyaos -> 「進捗ダメです」の隠語

    これを他人が追える? => 無理 .gitmessage を整備して虚無コミットログをやめよう .gitmessage を整備して虚無コミットログをやめよう 7 7
  3. a.c の関数とb.c の関数とc.c の関数とd.c の関数とe.c の関数と... a.c の関数では... b.c の関数では...

    c.c の関数では... d.c の関数では... がんばりました! => わからん! .gitmessage を整備して虚無コミットログをやめよう .gitmessage を整備して虚無コミットログをやめよう 9 9
  4. (主観的に)いい例 ADD Code Template for Dijkstra's Algorithm ダイクストラ法のライブラリを整備した。 テストケース: [AOJ

    なんとか...] reference: [ サイトとか] .gitmessage を整備して虚無コミットログをやめよう .gitmessage を整備して虚無コミットログをやめよう 11 11
  5. (主観的に)いい例再掲 ADD Code Template for Dijkstra's Algorithm ダイクストラ法のライブラリを整備した。 テストケース: [AOJ

    なんとか...] reference: [ サイトとか] WHAT はある。WHY は性質上ない? .gitmessage を整備して虚無コミットログをやめよう .gitmessage を整備して虚無コミットログをやめよう 14 14
  6. (主観的に)いい例再掲 ADD Code Template for Dijkstra's Algorithm ダイクストラ法のライブラリを整備した。 [[WHY を追加]]

    理由: ダイクストラ法のライブラリがなかったため。 テストケース: [AOJ なんとか...] reference: [ サイトとか] WHY とWHAT を書いておくとコミットの意義がわかりやすい .gitmessage を整備して虚無コミットログをやめよう .gitmessage を整備して虚無コミットログをやめよう 15 15
  7. .gitmessage で認知コストを減らす コミットする際のテンプレート # でコメントアウトできる ガイドラインとかを書いておくと良い git commit -m ...

    ではなく git commit だけ .gitmessage を整備して虚無コミットログをやめよう .gitmessage を整備して虚無コミットログをやめよう 17 17
  8. .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
  9. 参考文献 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