如何生成格式化的 Git 提交消息
填写提交类型、作用域、消息和破坏性变更选项后,生成器会输出格式化的 Git 提交消息。留空消息或作用域时,相关部分可能由内置选项随机生成。
先了解它能做什么
Git 提交消息生成器适合在提交代码前整理一条结构化消息。你可以提供提交类型、作用域、消息内容和破坏性变更选项;也可以留空部分输入,让工具从内置选项或模板中生成文本。它输出的是提交消息文本,不会替你执行 Git 命令或直接创建提交。
生成 Git 提交消息的步骤
-
准备提交信息。根据你的改动填写提交类型、作用域和消息内容。提交类型应使用工具能够识别的类型;作用域用于说明受影响的模块或区域,消息内容用于描述改动。
-
设置作用域。填写非空作用域时,生成的消息会把它放在括号中。如果不填写,工具会从内置作用域集合中选择一个。
-
填写消息正文。输入非空消息后,工具会使用这段文字作为消息内容。留空时,工具会从内置模板和词语列表中随机组合消息文本。
-
处理破坏性变更。只有在确实存在不兼容改动时才启用该选项。启用后,生成文本会先换行,再追加破坏性变更说明;关闭时不会追加这段说明。
-
生成并检查结果。提交后查看生成的完整文本,确认类型、作用域、消息含义和破坏性变更说明符合你的改动,再将文本复制到你自己的提交流程中。工具还会在正文后换行并追加三条固定项目符号行,因此请一并检查这些内容是否适合你的仓库规范。
如何检查生成结果
结果应是一段格式化的 Git 提交消息。非空消息会保留为消息文本;非空作用域会出现在括号中;空消息或空作用域则可能触发内置的随机选择。启用破坏性变更后,结果中应出现额外的空行和破坏性变更说明,末尾还会有空行及三条固定项目符号行。
这些规则说明了结果的组成方式,但不能据此判断消息一定适合某个仓库,也不能把生成结果当作已经完成的 Git 提交。若处理失败,工具会报告失败并附带异常文本;此时应检查输入并重新处理。
使用示例
你刚更新了登录页面的提示文字,希望先得到一条可供提交流程使用的结构化消息。
在生成器中输入提交类型“chore”、作用域“登录”、消息“更新登录提示文字”,保持破坏性变更选项关闭,然后生成文本并检查其结构。
结果是一段格式化文本:非空作用域位于括号中,输入的非空消息作为消息文本;末尾还包括空行和三条固定项目符号行。
使用限制
- 生成的是提交消息文本,不代表工具会执行 Git 命令、修改仓库或创建提交,也不保证消息适合特定仓库。
常见错误
- 将消息输入留空后仍期待工具保留自己的描述。请填写非空消息;留空时,工具会改用内置模板和词语随机生成消息文本。
常见问题
可以指定 Git 提交类型吗?
可以,但前提是提交类型属于工具能够识别的类型;无法识别或未填写时,工具会从内置类型集合中随机选择。
不填写消息会发生什么?
填写非空消息时,工具会使用你提供的文字;留空时,它会从内置模板和词语列表中随机构造消息。
破坏性变更选项会改变输出吗?
启用破坏性变更选项后,结果会先追加一个空行,再追加破坏性变更说明;此外,结果正文末尾还会追加三条固定项目符号行。