欢迎来到
代码提交的注释格式
定义
编辑
团队对提交的commit message格式有约定俗称的要求，即约定式提交规范，
实践出处
编辑
为什么
编辑
-
自动化生成 CHANGELOG。
-
基于提交的类型，自动决定语义化的版本变更。
-
向同事、公众与其他利益关系者传达变化的性质。
-
触发构建和部署流程。
-
让人们探索一个更加结构化的提交历史，以便降低对你的项目做出贡献的难度。
何时使用
编辑
团队内需要统一代码提交信息时。
如何使用
编辑
目前规范使用较多的是 Angular 团队的规范，继而衍生了 Conventional Commits specification。很多工具也是基于此规范，它的 message 格式如下：
Commit message 的格式
每次提交，Commit message 都包括三个部分：Header，Body 和 Footer。
<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>
其中，Header 是必需的，Body 和 Footer可以省略。
不管是哪一个部分，任何一行都不得超过72个字符（或100个字符）。这是为了避免自动换行影响美观。
Header
Header部分只有一行，包括三个字段：type（必需）、scope（可选）和 subject（必需）。
-
type
type用于说明commit的类别。
feat：新功能（feature）
fix：修补bug
docs：文档（documentation）
style：格式（不影响代码运行的变动）
refactor：重构（即不是新增功能，也不是修改bug的代码变动）
test：增加测试
chore：构建过程或辅助工具的变动
-
scope
scope用于说明commit影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。 -
subject
subject是commit目的的简短描述，不超过50个字符。
-
以动词开头，使用第一人称现在时，比如
change，而不是changed或changes。 -
第一个字母小写。
-
结尾不加句号（
.）。
Body
Body 部分是对本次 commit 的详细描述，可以分成多行。
这是一个范例：
More detailed explanatory text, if necessary. Wrap it to
about 72 characters or so.
Further paragraphs come after blank lines.
- Bullet points are okay, too
- Use a hanging indent
有两个注意点。
-
使用第一人称现在时，比如使用
change而不是changed或changes。 -
应该说明代码变动的动机，以及与以前行为的对比。
Footer
Footer 部分只用于两种情况。
-
不兼容变动
如果当前代码与上一个版本不兼容，则Footer部分以BREAKING CHANGE开头，后面是对变动的描述、以及变动理由和迁移方法。 -
关闭
Issue
如果当前commit针对某个issue，那么可以在Footer部分关闭这个issue。
Close #123
Revert
还有一种特殊情况，如果当前 commit 用于撤销以前的 commit，则必须以revert:开头，后面跟着被撤销 Commit 的 Header。
Body 部分的格式是固定的，必须写成This reverts commit <hash>.，其中的hash是被撤销 commit 的 SHA 标识符。
revert: fix: build index error
This reverts commit b97027476171c1b76a94a79cb9ba25f4942e4f9d.
我们非常重视知识产权，我们在非常努力地寻找最初的出处来源并注明出处。但因为互联网信息浩瀚，难免会有疏漏。如果您觉得有侵犯您的权益，请联系我们。
导出代码提交的注释格式.pdf
导出代码提交的注释格式.docx
导出代码提交的注释格式.pptx分享
