Gitコミットメッセージをうまく書く方法
(insight.infograb.net)- コミットメッセージを適切に書くべき理由
- 一貫性があり明確なコミットメッセージは、他の開発者がより簡単に理解する助けになる
- 良いコミットメッセージを使うと、コードの問題をより簡単にデバッグできる
- よく作られた git コミットメッセージは、そのプロジェクトで作業する他の開発者や未来の自分に変更内容のコンテキストを伝える
- 良いコミットメッセージの書き方
- 先頭にどのような内容を含むコミットなのか、コミットタイプを指定する
- 他の人への配慮として、詳しくコミットメッセージを書く (
commit bodyを使う) - コミットメッセージは命令または依頼する口調を使う
- 不要な句読点を取り除く
- チームで定義した「コミット規約」に従う
- インフォグラブ・プロダクトチームのコミット規約
- コミットの種類ごとに絵文字を追加し、一目で見やすくする
- コンポーネント、ページ、関数を区別するため、コンポーネントは大文字、それ以外のページと関数は小文字で表記する
commit bodyを使って詳細事項をコミットに追加する- 簡潔なコミットメッセージのために、「function」という単語を「関数」と省略して書く
2件のコメント
絵文字が可読性を向上させるという点には、本当に同意しにくいですね。3つくらいまでならまだしも……
この記事もおすすめです。
https://chris.beams.io/posts/git-commit/
https://item4.github.io/2016-11-01/How-to-Write-a-Git-Commit-Message/