提交 288d3f6b authored 作者: zjm's avatar zjm

docs(系统辅助): 添加自动生成的提交信息相关文档

添加自动生成的提交信息相关文档
上级 ef5b5b6b
# (2021-08-19)
### Bug Fixes
* **单位模块:** 过滤某些单位 ([0fbe290](https://git.yfzx.zjtys.com.cn/matrix/device-back/commits/0fbe29044a988499045a5c9b5585277ea73f5492))
* **核查模块:** 丰富了refresh接口里的信息 ([6cfee6e](https://git.yfzx.zjtys.com.cn/matrix/device-back/commits/6cfee6e42ddb5108f15a3d610e90834525483118))
* **自查模块,装备管理:** 修改部分bug ([a96297d](https://git.yfzx.zjtys.com.cn/matrix/device-back/commits/a96297d76d39589cd974a9338a971c7f441d3106))
### Features
* **清退、销毁、报废、丢失、退役模块:** 统一添加了根据任务id查询业务相关单据接口 ([ef5b5b6](https://git.yfzx.zjtys.com.cn/matrix/device-back/commits/ef5b5b6bcc7ae727edd33221e2ddb4af0cd8dd68))
* **用户模块:** 单位列表左侧列表接口修改 ([c395480](https://git.yfzx.zjtys.com.cn/matrix/device-back/commits/c3954803aad0414647cfea47036d3e3c12f2f947)), closes [#2](https://git.yfzx.zjtys.com.cn/matrix/device-back/issues/2)
* **系统配置:** 新增了库房存放位置 ([f61756d](https://git.yfzx.zjtys.com.cn/matrix/device-back/commits/f61756d90c36d520313aacd6790035a09633b2e1))
* **维修管理:** 新增了查询多个id的接口 ([157fbe9](https://git.yfzx.zjtys.com.cn/matrix/device-back/commits/157fbe98d3178741d83c765dd24c8aca2d079971))
* **自查模块,装备管理模块:** 修改库房存放位置,系统自查 ([2bc956f](https://git.yfzx.zjtys.com.cn/matrix/device-back/commits/2bc956f4d226206e3dc8a98002212dd11b16cf3f))
* **装备管理:** 新增了是否是配件字段 ([8b5ca58](https://git.yfzx.zjtys.com.cn/matrix/device-back/commits/8b5ca585b6f7a75ceaaf7f3d7dfa9ddcd808a44e))
......@@ -8,7 +8,7 @@
"path": "./node_modules/cz-conventional-changelog"
}
},
"version": "1.0.2",
"version": "0.9.8.3",
"scripts": {
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0 && git add CHANGELOG.md"
}
......
## 开发流程与规范
### 整体流程
![装备开发部署流程](/images/装备开发部署流程.jpg)
**组长流程**
两份文档 - changelog(自生成) 组员任务表(分发任务)
1. 获得任务,设定里程碑的目标与截止时间
2. 分发任务给开发人员
3. 开发人员领取任务,在自己本地完成后与前端对接测试完毕后提交到DEV(以整块的任务需求来提交)
4. 组长在确认无误后,生成changeLog,在Gitlab上合并到master上,关闭相关issuse
5. 里程碑完成后,在master中打tag
**开发人员需要知道的**
- stash与pop 相关的操作
- 出现部分功能要先上了 先做代码分割
### Commit的规范
#### Commit格式
```
<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>
```
**type**
- feat:新功能(feature)
- fix:修补bug
- docs:文档(documentation)
- style: 格式(不影响代码运行的变动)
- refactor:重构(即不是新增功能,也不是修改bug的代码变动)
- test:增加测试
- chore:构建过程或辅助工具的变动
ps : 如果`type``feat``fix`,则该 commit 将肯定出现在 Change log 之中。
**scope**
为模块名,例如核查模块
**subject**
关于项目的简短描述,不超过50个字
**Body**
- Body 部分是对本次 commit 的详细描述,可以分成多行。
- 应该说明代码变动的动机,以及与以前行为的对比。
**Footer**
- 如果当前 commit 针对某个issue,那么可以在 Footer 部分关闭这个 issue 。例如
```
Closes #234
```
### Git commit template模板Commit
**安装**
plugins里安装
### 自动生成changeLog
- 安装 `npm install -g commitizen`
- 安装 `npm install cz-conventional-changelog --save-dev`
- 安装 `npm install -g conventional-changelog-cli`
配置`package.json`
```
{
"devDependencies": {
"commitizen": "^4.0.3",
"cz-conventional-changelog": "^3.0.2"
},
"config": {
"commitizen": {
"path": "./node_modules/cz-conventional-changelog"
}
},
"version": "1.0.2",
"scripts": {
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0 && git add CHANGELOG.md"
}
}
```
### 生成changelog
- 追加 `conventional-changelog -p angular -i CHANGELOG.md -s `
- 全部生成 `conventional-changelog -p angular -i CHANGELOG.md -s -r 0`
### 组长发布的流程
-`dev`分支中生成changelog,随后push到仓库的dev分支中
- 在gitlab上进行合并,将dev的内容合并到master中
- 主场在本地拉取master内容,打tag,推送到远端仓库。
## 流水线信息
- jenkins地址 `http://192.168.100.247:8080`
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论