一云博客 - Commit
type: channel
link: https://blog.yiyunt.cn/index.php/tag/Commit/
items: Commit message 和 Change log 编写指南

Commit message 和 Change log 编写指南
type: item
date: 2024-04-19T15:27:00+08:00
description: Git 每次提交代码，都要写 Commit message（提交说明），否则就不允许提交。$ git commit -m "hello world"上面代码的 -m 参数，就是用来指定 commit mesage 的。如果一行不够，可以只执行 git commit ，就会跳出文本编辑器，让你写多行。$ git commit基本上，你写什么都行（这里，这里和这里）。但是，一般来说，commit message 应该清晰明了，说明本次提交的目的。目前，社区有多种 Commit message 的写法规范。本文介绍Angular 规范 ，这是目前使用最广的写法，比较合理和系统化，并且有配套的工具。一、Commit message 的作用格式化的Commit message，有几个好处。 （1）提供更多的历史信息，方便快速浏览。 比如，下面的命令显示上次发布后的变动，每个commit占据一行。你只看行首，就知道某次 commit 的目的。$ git log <last tag> HEAD --pretty=format:%s（2）可以过滤某些commit（比如文档改动），便于快速查找信息。 比如，下面的命令仅仅显示本次发布新增加的功能。$ git log <last release> HEAD --grep feature（3）可以直接从commit生成Change log。 Change Log 是发布新版本时，用来说明与上一个版本差异的文档，详见后文。二、Commit message 的格式每次提交，Commit message 都包括三个部分：Header，Body 和 Footer。<type>(<scope>): <subject> // 空一行 // 空一行 其中，Header 是必需的，Body 和 Footer 可以省略。不管是哪一个部分，任何一行都不得超过72个字符（或100个字符）。这是为了避免自动换行影响美观。2.1 HeaderHeader部分只有一行，包括三个字段： type （必需）、 scope （可选）和 subject （必需）。（1）type type 用于说明 commit 的类别，只允许使用下面7个标识。feat：新功能（feature） fix：修补bug docs：修改文档，比如README.md、CHANGELOG.md等；文档（documentation） style： 格式（不影响代码运行的变动）修改代码的格式，不影响代码运行的变动，比如空格、格式化代码、补齐句末分号等等； refactor：重构（没有新功能的添加以及bug修复的代码改动） perf：优化代码以提高性能 test：增加测试 build：修改影响项目构建文件或外部依赖项，比如npm、gulp、webpack、broccoli等 ci：修改CI配置文件和脚本； chore：构建过程或辅助工具的变动 revert：代码回退；如果 type 为 feat 和 fix ，则该 commit 将肯定出现在 Change log 之中。其他情况（ docs 、 chore 、 style 、 refactor 、 test ）由你决定，要不要放入 Change log，建议是不要。（2）scope scope 用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。（3）subject subject 是 commit 目的的简短描述，不超过50个字符。以动词开头，使用第一人称现在时，比如change，而不是changed或changes 第一个字母小写 结尾不加句号（.）2.2 BodyBody 部分是对本次 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有两个注意点。（1）使用第一人称现在时，比如使用 change 而不是 changed 或 changes 。（2）应该说明代码变动的动机，以及与以前行为的对比。2.3 FooterFooter 部分只用于两种情况。 （1）不兼容变动 如果当前代码与上一个版本不兼容，则 Footer 部分以 BREAKING CHANGE 开头，后面是对变动的描述、以及变动理由和迁移方法。BREAKING CHANGE: isolate scope bindings definition has chan…