Git commit message和工作流规范

Git commit日志基本规范

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

对格式的说明如下:

● type代表某次提交的类型,比如是修复一个bug还是增加一个新的feature。所有的type类型如下:
● feat: 新增feature
● fix: 修复bug
● docs: 仅仅修改了文档,比如README, CHANGELOG, CONTRIBUTE等等
● style: 仅仅修改了空格、格式缩进、都好等等,不改变代码逻辑
● refactor: 代码重构,没有加新功能或者修复bug
● perf: 优化相关,比如提升性能、体验
● test: 测试用例,包括单元测试、集成测试等
● chore: 改变构建流程、或者增加依赖库、工具等
● revert: 回滚到上一个版本

标题行:50个字符以内,描述主要变更内容 # # 主体内容:更详细的说明文本,建议72个字符以内。 需要描述的信息包括:

  1. 为什么这个变更是必须的? 它可能是用来修复一个bug,增加一个feature,提升性能、可靠性、稳定性等等
  2. 他如何解决这个问题? 具体描述解决问题的步骤
  3. 是否存在副作用、风险?
  4. 尾部:如果需要的化可以添加一个链接到issue地址或者其它文档,或者关闭某个issue。复制代码

格式要求:

Git分支与版本发布规范

● 基本原则:master为保护分支,不直接在master上进行代码修改和提交。
● 开发日常需求或者项目时,从master分支上checkout一个feature分支进行开发或者bugfix分支进行bug修复,功能测试完毕并且项目发布上线后,将feature分支合并到主干master,并且打Tag发布,最后删除开发分支。分支命名规范:
○ 分支版本命名规则:分支类型 分支发布时间 分支功能。比如:feature_20170401_fairy_flower
○ 分支类型包括:feature、 bugfix、refactor三种类型,即新功能开发、bug修复和代码重构
○ 时间使用年月日进行命名,不足2位补0
○ 分支功能命名使用snake case命名法,即下划线命名。

● Tag包括3位版本,前缀使用v。比如v1.2.31。Tag命名规范:
○ 新功能开发使用第2位版本号,bug修复使用第3位版本号
○ 核心基础库或者Node中间价可以在大版本发布请使用灰度版本号,在版本后面加上后缀,用中划线分隔。alpha或者belta后面加上次数,即第几次alpha:
■ v2.0.0-alpha-1
■ v2.0.0-belta-1
● 版本正式发布前需要生成changelog文档,然后再发布上线。

猜你喜欢

转载自blog.csdn.net/Orange_hhh/article/details/128956380