提出フォーマット:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
コミットメッセージは 100 文字を超えないようにしてください。
コミットメッセージには、ヘッダー、本文、フッターが含まれており、ヘッダーは必ず含まれている必要があります。
ヘッダー#
以下の形式で指定します:
<type>(<scope>): <subject>
ここで、scope はオプションで、変更の位置を指定する任意の内容にすることができます。
type は次のいずれかに指定します:
- build:ビルドシステムまたは外部依存関係の変更
- ci:CI 設定ファイルまたはスクリプトの変更
- docs:ドキュメントの変更
- feat:新機能の追加
- fix:バグ修正
- perf:パフォーマンスを向上させるコードの変更
- refactor:コードのリファクタリング
- style:スペース、フォーマット、セミコロンの欠落など、コードの意味に影響を与えない変更
- test:テストの追加またはテストコードの変更
subject は変更の簡潔な説明を行います。通常、次の原則を使用します:
- 命令形、現在時制を使用します
- 先頭に大文字を使用しないでください
- 文末に句点を追加しないでください
本文#
subject の設定と同様に、命令形と現在時制を使用します。
通常、変更の動機と以前の動作の比較を含める必要があります。
フッター#
すべての非互換の変更は、フッターに「BREAKING CHANGE:」で始まる中断変更ブロックとして記述する必要があります。その後にはスペースまたは 2 つの改行が続き、その他の情報はこの変更の説明、変更の理由、変更のコメントです。
BREAKING CHANGE: isolate scope bindings definition has changed and
the inject option for the directive controller injection was removed.
To migrate the code follow the example below:
Before:
。。。
。。。
After:
。。。
。。。
The removed `inject` wasn't generaly useful for directives so there should be no code using it.
このコミットが問題を修正する場合、フッターでその問題を参照する必要があります。キーワード「Closes」で始まり、次のようになります:
Closes #234
複数の問題はコンマで区切られます。
Closes #123, #245, #992
このコミットにロールバック操作が含まれている場合、フッターは「revert:」で始まり、本文には「This reverts commit hash」が追加されます。ここで、ハッシュ値はロールバック前のコミットを示します。
revert:<type>(<scope>): <subject>
<BLANK LINE>
This reverts commit hash
<other-body>
<BLANK LINE>
<footer>