深圳大演绎科技 开发人员 Git 使用规范

深圳大演绎科技 开发人员 Git 使用规范

一、提交规范

1、提交时commit不得为空

2、格式

提交信息包括两个部分:Header,Body

<Header>

<Body>

其中,Header 是必需的,BodyFooter 可以省略。

Header:

Header部分只有一行,包括俩个字段:type(必需)和subject(必需)。

<type>: <subject>

type用于说明 commit 的类别,可以使用如下类别(如果一次提交可以有多个类别,使用主要的类别):

  • feat:新功能(feature)
  • fix:修补bug
  • doc:文档(documentation)
  • style: 格式(不影响代码运行的变动)
  • refactor:重构(即不是新增功能,也不是修改bug的代码变动)
  • test:增加测试
  • chore:构建过程或辅助工具的变动

subject是 commit 目的的简短描述。

结尾不加句号(。)

Body

Body 部分是对本次 commit 的详细描述,可以分成多行。下面是一个范例。

- 修改了XXX界面的逻辑,用来处理XXX情况
- 增加相应的单元测试

注意:应该说明代码变动的动机,以及与以前行为的对比。

Footer

3、例子

下面是一个完整的例子:

feat: 添加了分享功能

给每篇博文添加了分享功能

- 添加分享到微博功能
- 添加分享到微信功能
- 添加分享到朋友圈功能

务必清晰简洁

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Git 每次提交代码, 都要写 Commit message (提交说明), 否则就不允许提交 $ git com...
    oneofai阅读 14,890评论 1 2
  • Git 每次提交代码,都要写 Commit message(提交说明),否则就不允许提交。 上面代码的-m参数,就...
    andyJi阅读 7,918评论 0 0
  • 整理自《Commit message 和 Change log 编写指南》-阮一峰 Commit message目...
    huanqiang阅读 25,289评论 0 8
  • Git 基础用法 SVN与Git(集中式VS分布式) 集中式 分布式 工作区 电脑中能够看到的目录就是工作区。 版...
    GeekerHua阅读 3,777评论 0 0
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 135,473评论 19 139