投稿

[GitHub 100日チャレンジ] Day 30 - コミットメッセージの書き方

良いコミットメッセージの条件、短く意味が伝わる書き方、よく使う動詞の例を学びます。

[GitHub 100日チャレンジ] Day 30 - コミットメッセージの書き方

コミットメッセージは履歴の説明

コミットメッセージは、あとから履歴を読む人への説明です。自分だけのプロジェクトでも、数週間後の自分が読むことになります。

短くても「何を変えたか」が分かるメッセージにしましょう。

良い例

1
2
3
Add README
Fix typo in setup guide
Update gitignore for Python

避けたい例

1
2
3
4
update
fix
asdf
work

内容が分からないメッセージは、あとで履歴を追うときに困ります。

書き方のコツ

  • 変更内容を短く書く
  • 動詞から始める
  • 一つのコミットに一つの目的を持たせる
  • 細かすぎる作業ログにしない

今日のゴール

自分の変更に対して、あとから読んでも意味が分かるコミットメッセージを書けるようになりましょう。

この投稿は投稿者によって CC BY 4.0 の下でライセンスされています。