Loading... 本文介绍[Angular 规范](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#heading=h.greljkmo14y0),这是目前使用最广的写法,比较合理和系统化,并且有配套的工具。 # Commit message 的作用 - **提供更多的历史信息,方便快速浏览** - **可以过滤某些commit(比如文档改动),便于快速查找信息** - **可以直接从commit生成Change log** # 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 的类别,只允许使用下面7个标识。 ``` feat:新功能(feature) fix:修补bug docs:文档(documentation) style: 格式(不影响代码运行的变动) refactor:重构(即不是新增功能,也不是修改bug的代码变动) test:增加测试 chore:构建过程或辅助工具的变动 ``` 如果`type`为`feat`和`fix`,则该 commit 将肯定出现在 Change log 之中。其他情况(`docs`、`chore`、`style`、`refactor`、`test`)由你决定,要不要放入 Change log,建议是不要。 ### 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 部分只用于两种情况。 **(1)不兼容变动** 如果当前代码与上一个版本不兼容,则 Footer 部分以`BREAKING CHANGE`开头,后面是对变动的描述、以及变动理由和迁移方法。 ``` BREAKING CHANGE: isolate scope bindings definition has changed. To migrate the code follow the example below: Before: scope: { myAttr: 'attribute', } After: scope: { myAttr: '@', } The removed `inject` wasn't generaly useful for directives so there should be no code using it. ``` **(2)关闭 Issue** 如果当前 commit 针对某个issue,那么可以在 Footer 部分关闭这个 issue 。 ``` Closes #234 ``` 也可以一次关闭多个 issue 。 ``` Closes #123, #245, #992 ``` ## Revert 还有一种特殊情况,如果当前 commit 用于撤销以前的 commit,则必须以`revert:`开头,后面跟着被撤销 Commit 的 Header。 ``` revert: feat(pencil): add 'graphiteWidth' option This reverts commit 667ecc1654a317a13331b17617d973392f415f02. ``` Body部分的格式是固定的,必须写成`This reverts commit <hash>.`,其中的`hash`是被撤销 commit 的 SHA 标识符。 如果当前 commit 与被撤销的 commit,在同一个发布(release)里面,那么它们都不会出现在 Change log 里面。如果两者在不同的发布,那么当前 commit,会出现在 Change log 的`Reverts`小标题下面。 # Commitizen [Commitizen](https://github.com/commitizen/cz-cli)是一个撰写合格 Commit message 的工具。 全局安装命令如下。 ``` npm install -g commitizen cz-conventional-changelog ``` 在您的目录中创建一个`.czrc`文件,并引用首选的全局安装的适配器 ``` echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc ``` 以后,凡是用到`git commit`命令,一律改为使用`git cz`。这时,就会出现选项,用来生成符合格式的 Commit message。  # conventional-changelog-cli 如果你的所有 Commit 都符合 Angular 格式,那么发布新版本时, Change log 就可以用脚本自动生成 每个部分都会罗列相关的 commit ,并且有指向这些 commit 的链接。当然,生成的文档允许手动修改,所以发布前,你还可以添加其他内容。 [conventional-changelog-cli](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli)就是生成 Change log 的工具,运行下面的命令即可。 ``` npm install -g conventional-changelog-cli cd my-project conventional-changelog -p angular -i CHANGELOG.md -s ``` 上面命令不会覆盖CHANGELOG.md文档,只会在文档前面新增,如果你想生成所有发布的 Change log,要改为运行下面的命令: ``` conventional-changelog -p angular -i CHANGELOG.md -s -r 0 ``` # 参考 - [Commit message 和 Change log 编写指南](https://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html) 最后修改:2023 年 01 月 30 日 © 允许规范转载 打赏 赞赏作者 支付宝微信 赞 0 如果觉得我的文章对你有用,请随意赞赏