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

適切な情報を残そう

コミットメッセージにはどのような情報を残すべきだろうか?

はじめに

対象読者

目次

Gitを使ったソフトウェア開発で、なぜコミットメッセージが重要なのか?

コードの5W1H / コミットメッセージの役割

レビューもしやすく

コミットメッセージのテンプレート

テンプレート

1行目: コミットの内容を表す絵文字 + 変更内容を簡潔に英語の命令形で記述
2行目: 空行
3行目以降: なぜ変更したのか詳細な説明を日本語で記述
:art: Add new images for Summer campaign夏のキャンペーンのため、新規の広告イメージを追加
詳細は #2

2行目に空行を設ける

絵文字について

コミットサブジェクトは英語で書く

__Add__ new feature!
__Remove__ hogehoge feature because of the delay of the project
__Remove__ the setting file because of the change of UI
新機能を__追加__!
プロジェクトの遅延に伴うほげほげ機能の__除去__
UIの変更にともなう設定ファイルの__除去__

3行目以降はなぜ変更したのかを詳しく記述する

各コメントの日付けからURLを取得できる

まとめ

参考

宣伝

👩‍💻 Building Apps. https://risacan.github.io/about ❤️ Git, GitHub, Ruby

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store