Git

Dorothy

Dorothy 是我的 Git Commit Message 的约定。

以下在 LeanCloud CM Guide 的基础上,我们整理了一份尽量简单且能记录代码提交意义的约定。

主要格式

提交类型:变动内容,简短描述,50 个字符

提交描述,可选,72 字符内,说明该提交的原因,或是提交的副作用。与第一行之间存在空行

注释及其它,可选

简单示例

fix: 更改 VuePress 版本,修复布局错乱问题

https://github.com/vuejs/vuepress/issues/1321

上面这个示例是一种“修复类型(fix)”示例,其描述链接了一个 GitHub Issue。

类型说明

类型有多种可能,以下几种是必须遵守的约定:

  • fix:错误修复
  • feat:新功能
  • chore:其它修改,如项目配置变动,构建任务变动
  • doc:注释或文档
  • format:代码改动(仅代码样式变更,如换行、分号)
  • css:前端界面样式变更

此外,还有一些类型可供参考及选用:

  • refactor:代码重构
  • perf:代码重构(仅性能改进)
  • test:与测试相关的改动

原则来说,依据不同项目,CM 规范可以做适当调整。以上只展现了一种通用的基础约定,具体项目可以在此基础上自行增添规则。如我的个人博客项目 CM 中,有一种“blogs”类型专门用作记录博客文字内容的修改。

特殊标记

特殊标记用作标注注意事项,如“BREAKING”、“close”标记的使用。特殊标记通常与项目工程化实践中其它工具配合使用,如用于关闭 GitLab Issues,后续有需要再展开约定。

feat: 大盘中国地图增加地图下钻功能

引入中国的省市映射文件,以通过选取的省找到省下所有城市内的店铺。

BREAKING: 下钻功能导致了地图缩放时错位的问题,所以暂时禁用了地图的拖拽能力

Copyright © 2024 Lionad - CC-BY-NC-CD-4.0