提交消息指南

提交说明

清晰的提交消息有助于更轻松地审核拉取请求，并更轻松地生成版本说明。Blockly 项目使用常规提交来帮助实现这一点。

每次提交都应采用以下格式：

<type>: <description>

[optional body]

[optional footer(s)]

请注意，核心 Blockly 代码库具有提交检查工具，可帮助强制执行此操作。如果您的拉取请求包含多个提交，则代码检查工具将检查标题。如果只有一个提交，则会检查该提交。最好是您的各个提交和拉取请求标题都遵循这些准则。

类型

类型不得为空，且必须全部为小写。以下是可接受的类型列表。

  • chore：对于完成例行/自动化任务（例如升级依赖项）的提交。

  • deprecate：对于弃用功能的提交。

  • feat：用于向 Blockly 添加新功能的提交。

  • fix：用于修复 Blockly 中的 bug/错误的提交。

  • 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。