Git 提交訊息

在此儲存庫中，我們使用並強制執行提交訊息規範。這些規範會使用 commitlint 和 Angular 設定 進行驗證。

這些規範的原因：#

  • 自動產生更新日誌
  • 簡化 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

訊息主旨（第一行）#

第一行不能超過 72 個字元，並且後面應該跟著一個空白行。類型和範圍應始終使用小寫，如下所示。

允許的 <type> 值：#

  • feat 表示使用者的新功能，而不是建置腳本的新功能。此類提交將觸發釋出 MINOR 版本。
  • fix 表示使用者的錯誤修復，而不是建置腳本的修復。此類提交將觸發釋出 PATCH 版本。
  • perf 表示效能改進。此類提交將觸發釋出 PATCH 版本。
  • docs 表示文件變更。
  • style 表示格式變更、缺少分號等。
  • refactor 表示重構程式碼，例如重新命名變數。
  • test 表示新增缺少的測試、重構測試；沒有程式碼變更。
  • build 表示更新建置設定、開發工具或其他與使用者無關的變更。

<scope> 值範例：#

  • init
  • runner
  • watcher
  • 設定
  • web-server
  • proxy
  • 等等

<scope> 可以是空的（例如，如果變更是全域性的或難以分配給單個組件），在這種情況下，括號會被省略。在較小的專案中，例如 Karma 外掛，<scope> 是空的。

訊息正文 #

就像在 <subject> 中一樣，使用祈使句、現在式：「變更」而不是「已變更」或「變更」。訊息正文應包含變更的動機，並與先前的行為形成對比。

參考議題 #

已關閉的議題應在頁尾的單獨一行中列出，並以「Closes」關鍵字作為前綴，如下所示

Closes #234

或者在多個議題的情況下

Closes #123, #245, #992

重大變更 #

所有重大變更都必須在頁尾中提及，並附上變更說明、理由和遷移注意事項。

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`.

任何包含重大變更部分的提交都將觸發 MAJOR 版本釋出，並獨立於提交類型顯示在更新日誌中。

本文檔基於 Angular 提交訊息格式。有關正確格式化提交訊息的範例，請參閱 提交歷史記錄。