読者です 読者をやめる 読者になる 読者になる

はらへり日記

腹に弾丸

Gitのコミットメッセージに接頭語をつけてる話

Gitのコミットメッセージのルールで何かいいのないかなぁとなんとなく思っていて

丁寧にまとまってる記事がすごくたくさんあって「お!これええやん!」ってなるものの使ってみると僕の場合は以下の2つの壁にぶち当たった

  • ルールを覚えられない

  • 選択肢が多すぎて、その時々で使い方が変わってしまう

    • fixbug fixの使い分けとか。一貫性がいつの間にか失われる

全っ然、細かく決まったルールをdisるつもりはないし実際多人数開発ではコミットを追うためにも必要だとは思うんだけども、

自分で普段から習慣づけて使ってみよう!って感覚ではちょいと手が出しづらかった。

なので僕が最近使ってるのは以下の様なルールでコミットしています。

コミットルール

  • [コミットの種類(4種類くらい)]: [コミット概要] #[あればissue番号]という形式でコミット

  • コミットの種類は主に以下のものを使っています

コミットの種類 意味
add 新たなファイルを追加
modify 改修、改良
fix 軽いバグ(typoやロジックのミス)修正
bug fix 致命的なbug fix

こんな感じで必要最低限のルールを自分に課すようになってからはいちいちルールを思い出すという作業が減りました。

実は自分はまだ研修中で現場に入っていないので、現場でのチーム開発だとこれでは困るのかもしれませんが、

自分でGitHubでボソボソ開発したりする分にはこれで事足りているし、結構幸せなので「コミットメッセージに一貫性持たせたいけどルール覚えるのはめんどくさい…」って人がいたら一回試してみてください。

何事も少しずつ始めるのが大事なんです…きっと。

以上

参考

Qitta: Gitのコミットメッセージの書き方

git commit時のコメントを英語で書くための最初の一歩