网站开发欠款,seo外链网站源码,长沙企业网页设计哪家专业,360网站地图怎么做一#xff0c;conventional commit(约定式提交)
Conventional Commits 是一种用于给提交信息增加人机可读含义的规范。它提供了一组用于创建清晰的提交历史的简单规则。
1.1 作用
自动化生成 CHANGELOG基于提交类型#xff0c;自动决定语义化的版本变更向项目相关合作开发…
一conventional commit(约定式提交)
Conventional Commits 是一种用于给提交信息增加人机可读含义的规范。它提供了一组用于创建清晰的提交历史的简单规则。
1.1 作用
自动化生成 CHANGELOG基于提交类型自动决定语义化的版本变更向项目相关合作开发者发送变更信心触发自动化构建和部署流程给开发者提供一个更加结构化的提交历史便于减低对项目做贡献的难度
1.2 提交格式
提交说明的结构如下
type(scope): subject
空行
[可选的正文]
空行
[可选的脚注]
1.2.1 Header
Header部分只有一行包括三个字段 type必需、scope必需和subject必需。
1type 类型
type用于说明 commit 的类别只允许使用下面7个标识
feat新功能featurefix修补bugdocs文档documentationstyle 格式不影响代码运行的变动refactor重构即不是新增功能也不是修改bug的代码变动test增加测试build构建过程或辅助工具的变动
2scope 范围
scope用于说明 commit 影响的范围比如指标模板、规则上下线等等视项目不同而不同。
3subject 主题
subject是 commit 目的的简短描述不超过50个字符。
1. 以动词开头使用第一人称现在时比如change而不是changed或changes
2. 第一个字母小写
3. 结尾不加句号.
1.2.2 Body 正文
Body 部分是对本次 commit 的详细描述可以分成多行。
1. 需要简要的列出各种正向或者反向的测试场景测试通过填pass。
2. 增加修改人信息 1.3 例子
1.3.1 feat例子
feat(规则上下线、构建、生效、仿真生效): 添加规则上下线功能 1. 规则上下线主流程引擎正常订阅fldl生成正常。 pass
2. 规则上下线传入不存在的规则编号异常提示。 pass提交人xxx
1.3.2 fix例子
fix(模型模块): 模型测试失败1. 导入mar模型包含衍生字段。 pass
2. 导入mar模型不包含衍生字段。 pass提交人xxx
二IDEA插件推荐
idea可以安装代码提交规范的插件。
安装插件
安装路径File-Settings-Plugins-Marketplace-搜索Conventional Commit点击安装即可。 提交时选择插件提交
提交的时候点击中间的小红点创建提交消息根据对话框提示填写相关信息即可生成规范的提交消息 三ChangeLog
3.1 自动生成ChangeLog工具
git-chgloghttps://github.com/git-chglog/git-chglog
优点如下
高移植性多平台、多环境支持简单易用高度灵活可自定message format和CHANGELOG.md Template
3.2 安装使用
# 交互式初始化 推荐选择gitlab样式、standard模式
git-chglog --init
本地配置项目根目录下.chglog的内容CHANGELOG.tpl.md和config.yml具体含义参考以上官方文档
使用打包机器或开发环境集成-规范化提交release tag-数据积累后命令生成
EXAMPLE:
$ git-chglog
If tag queryis not specified, it corresponds to all tags.Thisis the simplest example.$ git-chglog 1.0.0..2.0.0
The above is a command to generate CHANGELOG including commit of 1.0.0 to 2.0.0.$ git-chglog --output CHANGELOG.md
The above is a command to output to CHANGELOG.md instead of standard output.
CHANGELOG.md效果
