修訂訊息指南

修訂訊息

清楚的提交訊息可讓審查人員更輕鬆地審查提取要求，並輕鬆產生版本資訊。Blockly 專案使用傳統式提交來協助完成這項作業。

每個提交都應採用以下格式：

<type>: <description>

[optional body]

[optional footer(s)]

請注意，核心 Blockly 存放區有提交內容檢查工具，可協助強制執行這項操作。如果提取要求有多個提交，Linter 會檢查標題。如果只有單一提交，系統會檢查該提交。最好是個人提交的內容和提取要求標題都符合這些規範。

類型

型別不得為空白，且必須全部使用小寫。以下列出可接受的類型。

  • chore：適用於完成例行/自動化工作的提交，例如升級依附元件。

  • deprecate：適用於淘汰功能的提交。

  • feat：適用於在 Blockly 中新增功能的提交。

  • fix：用於修正 Blockly 中的錯誤/錯誤的提交。

  • release：與新版本發布相關的提交。

破壞性變更

如果提交的內容會造成重大變更，請在提交類型後附加 !。重大變更可能會導致開發人員在應用程式中使用 Blockly 時發生問題，進而需要額外作業。

例如：none fix!: return type of workspace.paste

重大變更可以是上述任何有效類型。

說明

說明不得為空白，且長度不得超過 256 個字元。

內文

內文為選填欄位。如果提供，則該行與說明之間應有空白行。每行不得超過 256 個字元。

請注意，通常建議您將這類資訊放在提取要求說明中，而不是直接放在提交中。

頁尾為選用項目。如有提供，標題和內文之間應有空白行。每行不得超過 256 個字元。

修正非傳統式提交

如果您在進行修改時未使用傳統提交，可以根據提交次數，透過下列兩種方式修正訊息：

  1. 如果提取要求有多項提交，請編輯提取要求標題，使其符合規定。合併提取要求後，系統會壓縮其他提交內容，並將標題做為提交訊息。

  2. 如果提取要求只有一個修訂版本，請使用 git commit --amend 修訂修訂版本訊息，然後強制將變更推送至 Blockly 的 Fork。系統會自動更新與這個分支相關聯的所有未結案提取要求。git push --force origin my-branch。