web-dev-qa-db-ja.com

git commitメッセージを書くときに従う標準

私は非常に多くのファイル(60を超え70未満)を管理しており、これまでのコミットメッセージは次のパターンに従っています:_layout.css_のようなものを追加すると、コミットメッセージは"レイアウトに追加されました.css file "、何かを削除すると、コミットメッセージは" relayed something from layout.css file "になります。

いくつかのファイルがあります。コミットフィードとadded ...およびremoved ...メッセージが優勢です。時々、削除したものや_layout.css_に追加したものを覚えていないことがあります。これは、一度に多くの変更を加えるため、適切なコミットメッセージを見つけるのに苦労するからです。

コミットメッセージを思い付くために従うべき標準はありますか?

74
Gandalf

行ったことを(「関数を追加した」などの技術的であいまいな用語で)単に説明するだけでは、Gitがコミットに既に保存しているものに多くを追加することはありません。しばらくしてコミットメッセージを読むことを想像してください。その変更の本質を他の開発者に最も思い出させる/伝えるには、どのような要約が役立ちますか?!正確な内容はプロジェクトとプロセスに依存しますが、それは良いガイドラインです。

したがって、何よりもまずコンテキスト(whyを追加し、howではなく)「追加されたfrob()関数」ではなく、コミットメッセージ(「永続化を有効にするためにメッセージをフロブナイズする」など)を使用します。それはより多くの努力です(あなたは反映する必要があり、think)、しかしそれはもっと価値があります。

このトピックについてさらに詳しく知りたい場合は、豊富な情報があります。たとえば、 Peter Huttererによるこのブログ記事 または この面白いスライド です。

77
Ingo Karkat

50/72モデルは良い習慣のようです。つまり...最初の行は最大50文字で、ヘッダーとして使用する必要があります。スペースが後に続き、2行目の行は72文字でラップされ、要約として機能します。 SO質問: Gitコミットメッセージ:50/72フォーマット )で、同じことを説明しています。

この件に関する包括的なメモを次に示します。

  1. GIT Commit Good Practice
  2. Gitコミットメッセージに関する注意
  3. 適切なGitコミットメッセージとエレガントなGit履歴
42
vijay

Gitはすでにコミットで変更したファイルを認識しているので、コメントで指定するのは無意味です。たとえば、「パディングのバグを修正」または「サイドバーにメニューを追加」と言うだけです。明確にしてください、それだけです。

10
mimipc