[Git]コミットメッセージの記述方法

Gitでは、コミット時にメッセージを記録することができます。
コミットメッセージに、メッセージを記録することで、ソースコードの変更履歴を残すことができます。

やすひら

コミットメッセージの記述方法

Gitのコミットメッセージとは

Gitでは、コミット時にメッセージを記録することができます。
コミットメッセージに、メッセージを記録することで、ソースコードの変更履歴を残すことができます。
ソースコードの変更履歴があると、開発がどのように進み、どのような経緯でソースコードを変更したのかがわかります。

コミットメッセージ例

perf(issue #123): ループ処理のCPU負荷による熱対策のためスリープ処理を追加

マイコンボードに接続されているセンサーで取得したの情報をリアルタイムで収集する機能を搭載したが、ループ処理によるCPU負荷が多かったため、熱対策としてセンサーからの情報収集を1秒間隔とするようスリープ処理を追加した。

コミットメッセージの例では、マイコンボードのセンサーからの情報取得処理のパフォーマンスを調整する変更をしていることがわかります。
issue番号と紐付けることで、どの課題がトリガーとなったかもわかります。

Gitのコミットメッセージの登録方法

コミットメッセージは、gitコメントで登録することができます。

変更をステージングエリアに追加

変更をステージングエリアに追加します。

コマンドライン

git add [ファイル名]

git add .

変更をステージングエリアに追加します。

コミット

コミット時にコミットメッセージを登録します。

コマンドライン

git commit -m "[コミットメッセージ(1行目)]" -m "[コミットメッセージ(3行目)]"

-m指定でコミットメッセージを指定して、コミットします。
1つ目と2つ目のコミットメッセージの間は空行となります。(2行目は空行)

Gitのコミットメッセージの記述方法

Gitのコミットメッセージは、フォーマットを決めて登録すると見やすくわかりやすいです。
コミットメッセージの留意事項についても紹介します。

コミットメッセージの留意事項

コミットメッセージの記述の留意事項を紹介します。

短く明確に記述

短く明確に記述することが重要です。
コミットメッセージは、長いと読みにくいため、短く明確に記述する必要があります。

変更理由/変更経緯を記述

未来から過去の変更内容を確認する場合、”なぜ”,”どのような経緯で”変更したのかがわかると、処理内容の意図がわかることがあります。
変更理由/変更経緯を記述することで、追加開発やバグ修正がしやすいので、意識して記述する必要が有ります。

フォーマットの一貫性

コミットメッセージのフォーマットを統一すると読みやすいです。
チームで作業を行う場合は、フォーマットに一貫性をもたせると、他のエンジニアにも見やすいメッセージが記録できます。

言語の選択

言語の選択は、チームのエンジニアの使用言語に合わせると良いです。
多国籍なチームで作業する場合は英語が適していますし、日本人向けにメッセージを記録する場合は日本語で記述するのが適しています。

コミットメッセージのフォーマット

コミットメッセージのフォーマットは、プロジェクトによってルールを決定すれば良いです。
本記事では筆者が考える良いフォーマットの例を紹介します。

フォーマット

[プレフィックス]([チケット番号]): [タイトル]

[変更内容]

コミットメッセージ例

perf(issue #123): ループ処理のCPU負荷による熱対策のためスリープ処理を追加

マイコンボードに接続されているセンサーで取得したの情報をリアルタイムで収集する機能を搭載したが、ループ処理によるCPU負荷が多かったため、熱対策としてセンサーからの情報収集を1秒間隔とするようスリープ処理を追加した。

プレフィックス

プレフィックスは、1単語でどのような変更かがわかるような種別を記述します。
プレフィックスの例を以下に示します。

該当するプレフィックスを選択して、コミットメッセージの先頭に記述します。

チケット番号

チケット番号を付与することで、プロジェクトの管理を行うことができます。
GitHub issues等の課題単位で、チケットを発行して、チケット番号からどの課題に関連しているかを紐付けることで、プロジェクトが管理しやすくなります。

チケット番号

issue #123

チケット番号がない場合は、省略しても問題ありませんが、チケット番号が発行されている場合は記録した方が、トレースしやすいです。

タイトル

タイトルは、どのような変更をしたのかを短文で端的に記述します。
短く明確で、変更理由/背景がわかる文字列で、変更内容を記述すると良いです。

タイトル

ループ処理のCPU負荷による熱対策のためスリープ処理を追加

修正内容の概要や要約を、タイトルとして記述します。
1行の短文で、変更内容が理解できる文字列が良いです。

変更内容

変更内容は、詳細な変更内容を記述します。
短く明確で、変更理由/背景がわかる文字列で、変更内容を記述すると良いです。

変更内容

マイコンボードに接続されているセンサーで取得したの情報をリアルタイムで収集する機能を搭載したが、ループ処理によるCPU負荷が多かったため、熱対策としてセンサーからの情報収集を1秒間隔とするようスリープ処理を追加した。

詳細な変更内容を記述します。
5W1Hがわかる内容で記述するのが望ましいです。

まとめ

Gitのコミットメッセージの記述方法について紹介しました。

Gitのコミットメッセージは、チームで作業する場合や過去の開発経緯を知るために不可欠な機能です。
他のエンジニアが見やすいようにコミットメッセージを記述すると良いです。