提交 d12ff0c5 authored 作者: Matrix's avatar Matrix

docs(文档): 补充readme.md里的开发流程

将开发流程添加到readme.md中了。
上级 f61756d9
### Device-back
[toc]
## 要点
- 项目的结构分好,删掉没用的文件,以及版本管理做好,分支,dev,release,hotfix
- dev , 开发分支
......@@ -10,11 +12,116 @@
- utils , config , common(bean,exception,filter ... ) , misc(其它)
- do , vo
- 日志,注释,事务
## 结构重新整合
- 分为 config 配置模块 放置所有的配置相关的代码
- device 包括所有的业务模块 以及人员模块 task等
- misc 放置所有的工具类代码
- rfid 标签模块
- socket 放置socket模块代码
- union 启动类
\ No newline at end of file
- union 启动类
## 开发流程与规范
### 整体流程
![装备开发部署流程](/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`
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论