内容提要
本文介绍了如何生成符合“常规提交”标准的结构化提交信息。用户可通过运行`git diff --staged`查看暂存更改,并生成包含类型、范围和简短描述的提交信息,同时提供质量规则和示例输出。
关键要点
-
本文介绍如何生成符合“常规提交”标准的结构化提交信息。
-
用户可通过运行`git diff --staged`查看暂存更改。
-
如果没有暂存更改,提示用户先运行`git add`。
-
生成提交信息时,不要询问澄清问题。
-
提交信息的输出格式包括类型、范围和简短描述。
-
类型包括:feat(新功能)、fix(修复bug)、docs(文档更改)、refactor(重构)、test(测试)、chore(构建过程或依赖更新)。
-
范围指受影响的模块、文件或区域,必要时可省略。
-
简短描述应为命令式,限制在72个字符以内,不使用句号。
-
正文部分描述更改及其原因,非如何实现,必要时使用项目符号。
-
脚注部分可包含`BREAKING CHANGE:`或`Closes #N`。
-
质量规则包括:避免使用“更新”、“更改”或“修改”,简短描述需具体且不超过72个字符。
-
示例输出展示如何生成结构化提交信息。
延伸问答
如何生成符合常规提交标准的结构化提交信息?
可以通过运行`git diff --staged`查看暂存更改,并生成包含类型、范围和简短描述的提交信息。
提交信息的输出格式是什么样的?
输出格式包括类型、范围和简短描述,类型有feat、fix、docs等,简短描述应为命令式,限制在72个字符以内。
如果没有暂存更改,我该怎么办?
如果没有暂存更改,应该先运行`git add`命令。
在生成提交信息时,有哪些质量规则需要遵循?
质量规则包括避免使用“更新”、“更改”或“修改”,简短描述需具体且不超过72个字符。
提交信息的正文部分应该包含什么内容?
正文部分应描述更改及其原因,非如何实现,必要时使用项目符号。
如何处理多个不相关的更改?
如果更改涉及超过三个不相关的文件,应标记为“这些更改可能更适合分成单独的提交”。