研发规范
2023-04-13 20:55:50 1 举报AI智能生成
描述研发过程中规范问题，主要考虑需要解决的问题点
作者其他创作
大纲/内容
git分支规范
git提交注释规范
描述
bugID
定义格式
【des】修复上传bug
【No.】79898438493
【No.】79898438493
版本changelog
开发规范
测试规范
生产规范
hotfix分支
文档管理
产品需求文档
git管理
设计、交互
git管理
蓝湖
禅道管理需求
业务线填写产品线
API文档
YAPI
doclever
进度管理
禅道管理
相关工具
禅道
蓝湖(企业版)
Confluence（企业版）
yapi
supervisord-monitor
supervisord集群版管理工具
Jenkins
代码规范
阿里Java规范嵩山版
其他规范
接口命名规范
统一采用下划线方式命名，不使用大小字母混用
POST接口接收数据统一采用body方式接收，不适用FormData或Form表单方式
所有body体内参数，采用pojo接收，禁止使用Map统一接收
代码审查
周六下午3点（待定）
数据库规范
使用flyway统一管理
脚本使用规范
所有SQL可以支持重复执行
统一采用--- 注释风格
禁止随意修改数据库字段名称
脚本分类
PRE脚本
1. 备份脚本（备份机制）
2. 执行脚本
3. 回滚脚本
POST脚本
1. 备份脚本
2. 执行脚本
3. 回滚脚本
约定
所有人不得手动修改测试、生产数据库
所有更改通过flyway统一版本管理
数据备份
平安云自动备份
ETC数据库备份
手动备份
发布规范
准备阶段
1. 确认发布内容
2. 确认发布数据库脚本
PRE脚本
1. 备份脚本
2. 执行脚本
3. 回滚脚本
POST脚本
1. 备份脚本
2. 执行脚本
3. 回滚脚本
3. 确认发布版本号
4. 确认发布脚本
ansible
发布发布
1. 执行PRE备份脚本
2. 执行PRE执行脚本
3. 执行发布脚本
4. 执行POST备份脚本
5. 执行POST执行脚本
6. 发布验证
回滚阶段
1. 执行POST回滚脚本
2. 执行发布脚本
3. 执行PRE回滚脚本
运维管理
ansible脚本运维
通过palybook文件定义部署文件内容
supervisor后台守护进程
异常通知方式
邮件
企业微信WebHook机器人
监控服务可用性
使用开发或开源监控接口响应
发版前邮件通知
模板
发版后邮件通知
模板
Jenkins
0 条评论
下一页
