セージ の メモ書き

メモこそ命の恩人だ

Git - コミットメッセージ

メッセージの書き方

例1

Gitコミットメッセージの7大原則 - rochefort's blog

How to Write a Git Commit Message

The seven rules of a great Git commit message

1. Separate subject from body with a blank line
2. Limit the subject line to 50 characters
3. Capitalize the subject line
4. Do not end the subject line with a period
5. Use the imperative mood in the subject line
6. Wrap the body at 72 characters
7. Use the body to explain what and why vs. how
No. 内容 補足
1 subject と body は空行で区切る
2 subject は50文字までにする オーバーする場合、変更過多の可能性あり
3 subject は大文字で始める 日本語なら、該当しない
4 subject は句点(。)で終わらない 無駄スペースのため
5 subject は命令形にする 敬語で丁寧に記載する必要はない
6 body は72文字までにする
7 body は how でなく what・why を記述する 理由が大事

例2

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

  • 以下の構成にする。
    • 1行目:変更内容の要約(タイトル、概要)
    • 2行目:空行
    • 3行目以降:変更した理由(内容、詳細)
  • 1行目に、コミット種別と要約を書く。
    • コミット種別
      • fix:バグ修正
      • hotfix:クリティカルなバグ修正
      • add:新規(ファイル)機能追加
      • などなど
  • 3行目に、変更理由を具体的に書く。
    • Redmine等のチケット番号 なども。


補足

GitHub

  • 51文字以上の場合、非推奨のメッセージが表示される。
  • 詳細はいくらでも記述できそう。10,000文字は書けることを確認。

Visual Studio

  • GitHub での見え方を試す。
  • 1行目は、GitHub で件名として表示される。
  • 2行目以降は、GitHub で詳細情報として表示される。
  • 1行目と2行目の間に空行を複数挿入しても、GitHub 上で補正される。



以上