Git コミットメッセージ

このリポジトリでは、コミットメッセージ規則を使用し、厳守しています。規則は commitlintAngular 設定 を使用して検証されます。

これらの規則の理由: #

  • 変更ログの自動生成
  • Git ヒストリーの簡単なナビゲーション(例:スタイルの変更の無視)

コミットメッセージの形式: #

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

コミットメッセージの例: #

fix(middleware): ensure Range headers adhere more closely to RFC 2616

Add one new dependency, use `range-parser` (Express dependency) to compute
range. It is more well-tested in the wild.

Fixes #2310

メッセージの subject(最初の行) #

最初の行は 72 文字以下で、空白行が続くようにする必要があります。次のように、タイプとスコープは常に小文字にする必要があります。

許可される <type> の値: #

  • feat ユーザー向けの新しい機能であって、ビルドスクリプトの新しい機能ではない場合。このようなコミットはリリースをトリガーし、MINOR バージョンを上げます。
  • fix ユーザー向けの不具合の修正であって、ビルドスクリプトの修正ではない場合。このようなコミットはリリースをトリガーし、PATCH バージョンを上げます。
  • perf パフォーマンスの向上。このようなコミットはリリースをトリガーし、PATCH バージョンを上げます。
  • docs ドキュメントに対する変更。
  • style フォーマットの変更、セミコロンの欠落など。
  • refactor 本番コードのリファクタリング(例:変数の変更)。
  • test テストの追加、テストのリファクタリング。本番コードの変更はありません。
  • build ユーザーとは関係のないビルド構成、開発ツール、またはその他の変更の更新。

<scope> の値の例: #

  • init
  • runner
  • watcher
  • 設定
  • web-server
  • proxy
  • など

<scope> は空にすることができます(例:変更がグローバルまたは単一のコンポーネントへの割り当てが困難な場合)。その場合、括弧は省略されます。Karma プラグインなどの小規模プロジェクトでは、<scope> は空です。

メッセージの本体 #

<subject> と同様に、命令形、現在形を使用します。つまり、「change」ではなく、「changed」でも「changes」でもありません。メッセージの本体には、変更の動機や、以前の動作との違いを含める必要があります。

問題の参照 #

クローズされた問題は、フッターの別の行に「Closes」キーワードをプレフィックスとして以下のようにリストする必要があります

Closes #234

または、複数の問題がある場合。

Closes #123, #245, #992

breaking 変更内容 #

すべての breaking 変更内容は、変更内容の説明、その正当性、およびマイグレーションメモと共にフッターに記載される必要があります。

BREAKING CHANGE:

`port-runner` command line option has changed to `runner-port`, so that it is
consistent with the configuration file syntax.

To migrate your project, change all the commands, where you use `--port-runner`
to `--runner-port`.

breaking 変更セクションを含むすべてのコミットは、コミットタイプに関係なく、MEJOR リリースをトリガーし、変更ログに表示されます。


このドキュメントは、Angular コミットメッセージ形式に基づいています。適切にフォーマットされたコミットメッセージの例については、コミット履歴を参照してください。