2020/6/11 Git

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

Gitへのコミットメッセージを記述する際に参考になるフォーマットを紹介します。

Google Angularのフォーマット

https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines

https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#

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

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

各行は100文字以内に記述する

Type

  • feat: 新しい機能
  • fix: バグ修正
  • docs: ドキュメントのみの変更
  • style: コードの意味に影響を与えない変更 (空白, 書式, セミコロンの欠落など)
  • refactor: バグ修正、機能追加を行わないコード変更
  • perf: パフォーマンスを向上させるコード変更
  • test: テストの追加、変更
  • chore: ビルドプロセスやドキュメント作成などの補助ツールやライブラリの変更

Scope

コミット対象の場所を指定するものであれば何でも良い

例）$location, $browser, $compile, $rootScope, ngHref, ngClick, ngView, etc…

Subject

  • 命令形の現在形を使用する
  • 最初の文字を大文字にしない
  • 末尾にドット（.）無し

Body

  • Subjectと同様に、命令形の現在形を使用する
  • 変更する理由を記述する
  • 変更前との動作の違いを記述する

Footer

重大な変更に関する情報が含まれている必要がある