banner
Tenifs

Tenifs

雄关漫道真如铁,而今迈步从头越。
github
zhihu
email

Angular コミットメッセージの規範

提出フォーマット:

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

1 回のコミットメッセージは 100 文字を超えないようにしてください。

コミットメッセージには、ヘッダー、本文、フッターが含まれており、ヘッダーは必ず含まれている必要があります。

ヘッダー#

以下の形式で指定してください:

<type>(<scope>): <subject>

ここで、scoop はオプションで、スコープは変更の位置を指定する任意の内容にすることができます。

type は次のいずれかに指定します:

  • build:ビルドシステムまたは外部依存関係の変更
  • ci:CI 設定ファイルまたはスクリプトの変更
  • docs:ドキュメントの変更
  • feat:新機能の追加
  • fix:バグ修正
  • pref:パフォーマンスを向上させるコードの変更
  • 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

複数の issue はコンマで区切って記述します。

Closes #123, #245, #992

このコミットにはロールバック (revert) 操作が含まれている場合、フッターは revert: で始まり、本文には This reverts commit hash を追加します。ここで、ハッシュ値はロールバック前のコミットを示します。

revert:<type>(<scope>): <subject>
<BLANK LINE>
This reverts commit hash
<other-body>
<BLANK LINE>
<footer>

参考資料#

読み込み中...
文章は、創作者によって署名され、ブロックチェーンに安全に保存されています。