Angular 推荐的 Commit message 格式

每次提交，Commit message 都包括三个部分：header，body 和 footer。

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

其中，header 是必需的，body 和 footer 可以省略。
不管是哪一个部分，任何一行都不得超过72个字符（或100个字符）。这是为了避免自动换行影响美观。

Header

Header部分只有一行，包括三个字段：type（必需）、scope（可选）和subject（必需）。

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 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。

例如在Angular，可以是$location, $browser, $compile, $rootScope, ngHref, ngClick, ngView等。

如果你的修改影响了不止一个scope，你可以使用*代替。

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。
  • 永远别忘了第2行是空行
  • 应该说明代码变动的动机，以及与以前行为的对比。

Footer

Footer 部分只用于以下两种情况：

不兼容变动

如果当前代码与上一个版本不兼容，则 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.

关闭 Issue

如果当前 commit 针对某个issue，那么可以在 Footer 部分关闭这个 issue 。

Closes #234

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小标题下面。

阿里推荐的 commit message 格式

<type>(<scope>): <subject>

type(必须)

用于说明git commit的类别，只允许使用下面的标识。

feat：新功能（feature）。

fix/to：修复bug，可以是QA发现的BUG，也可以是研发自己发现的BUG。

  • fix：产生diff并自动修复此问题。适合于一次提交直接修复问题
  • to：只产生diff不自动修复此问题。适合于多次提交。最终修复问题提交时使用fix

docs：文档（documentation）。

style：格式（不影响代码运行的变动）。

refactor：重构（即不是新增功能，也不是修改bug的代码变动）。

perf：优化相关，比如提升性能、体验。

test：增加测试。

chore：构建过程或辅助工具的变动。

revert：回滚到上一个版本。

merge：代码合并。

sync：同步主线或分支的Bug。

scope(可选)

scope用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。

例如在Angular，可以是location，browser，compile，compile，rootScope， ngHref，ngClick，ngView等。如果你的修改影响了不止一个scope，你可以使用*代替。

subject(必须)

subject是commit目的的简短描述，不超过50个字符。

建议使用中文（感觉中国人用中文描述问题能更清楚一些）。

  • 结尾不加句号或其他标点符号。
  • 根据以上规范git commit message将是如下的格式：
fix(DAO):用户查询缺少username属性 
feat(Controller):用户查询接口开发

以上就是我们梳理的git commit规范，那么我们这样规范git commit到底有哪些好处呢？

  • 便于程序员对提交历史进行追溯，了解发生了什么情况。
  • 一旦约束了commit message，意味着我们将慎重的进行每一次提交，不能再一股脑的把各种各样的改动都放在一个git commit里面，这样一来整个代码改动的历史也将更加清晰。
  • 格式化的commit message才可以用于自动化输出Change log。

使用表情

在使用命令行提交 commit 消息时，可以通过:关键字: 的方式进行使用表情。

git commit -m ":tada: Initial commit"

表情列表

使用时可以复制需要的 emoji 代码。

emoji emoji 代码 commit 说明
? (调色板) :art: 改进代码结构 / 代码格式
⚡️ (闪电) ? (赛马) :zap: :racehorse: 提升性能
? (火焰) :fire: 移除代码或文件
? (bug) :bug: 修复 bug
? (急救车) :ambulance: 重要补丁
✨ (火花) :sparkles: 引入新功能
? (备忘录) :memo: 撰写文档
? (火箭) :rocket: 部署功能
? (口红) :lipstick: 更新 UI 和样式文件
? (庆祝) :tada: 初次提交
✅ (白色复选框) :white_check_mark: 更新测试
? (锁) :lock: 修复安全问题
? (苹果) :apple: 修复 macOS 下的问题
? (企鹅) :penguin: 修复 Linux 下的问题
? (旗帜) :checkered_flag: 修复 Windows 下的问题
?（机器人） :robot: 修复 Android 下的问题
? (绿苹果) :green_apple: 修复 iOS 下的问题
? (书签) :bookmark: 发行 / 版本标签
? (警车灯) :rotating_light: 移除 linter 警告
? (施工) :construction: 工作进行中
? (工人) :construction_worker: 添加 CI 构建系统
? (绿心) :green_heart: 修复 CI 构建问题
⬆️ (上升箭头) :arrow_up: 升级依赖
⬇️ (下降箭头) :arrow_down: 降级依赖
? (图钉) :pushpin: 将依赖项固定到特定版本
? (上升趋势图) :chart_with_upwards_trend: 添加分析或跟踪代码
♻️ （回收） :recycle: 重构代码
? (鲸鱼) :whale: Docker 相关工作
? (带子午线的地球仪) :globe_with_meridians: 国际化与本地化
➕ (加号) :heavy_plus_sign: 增加一个依赖
➖ (减号) :heavy_minus_sign: 减少一个依赖
? (扳手) :wrench: 修改配置文件
? (锤子) :hammer: 重大重构
✏️ (铅笔) :pencil2: 修复 typo
? (粑粑…) :hankey: 写了辣鸡代码需要优化
⏪ (倒带) :rewind: 恢复更改
? (交叉向右的箭头) :twisted_rightwards_arrows: 合并分支
? (包裹) :package: 更新编译的文件或包
? (外星人) :alien: 由于外部 API 更改而更新代码
? (货车) :truck: 移动或者重命名文件
? (正面朝上的页面) :page_facing_up: 增加或更新许可证书
? (爆炸) :boom: 引入突破性的变化
? (铅笔) :bento: 增加或更新资源
? (OK 手势) :ok_hand: 由于代码审查更改而更新代码
♿️ (轮椅) :wheelchair: 改善无障碍交互
? (灯泡) :bulb: 给代码添加注释
? (啤酒) :beers: 醉醺醺地写代码…
? (消息气泡) :speech_balloon: 更新文本文档
? (卡片文件盒) :card_file_box: 执行与数据库相关的更改
? (音量大) :loud_sound: 增加日志
? (静音) :mute: 移除日志
? (轮廓中的半身像) :busts_in_silhouette: 增加贡献者
? (孩童通行) :children_crossing: 优化用户体验、可用性
? (建筑建造) :building_construction: 结构变动
? (iPhone) :iphone: 做响应式设计
? (小丑脸) :clown_face: 嘲弄事物（直译，这个没明白）
? (鸡蛋) :egg: 增加彩蛋
? (看不见邪恶) :see_no_evil: 增加或更改 gitignore
? (照相机闪光灯) :camera_flash: 增加或更新截图
⚗️ (蒸馏器) :alembic: 尝试新东西
? (放大镜) :mag: SEO 优化
☸️ (船的方向盘) :wheel_of_dharma: 关于 Kubernetes 的工作
? (标签) :label: 增加类型（FLow、Typescript）