Skip to content

Latest commit

 

History

History
48 lines (41 loc) · 2.02 KB

must_know.md

File metadata and controls

48 lines (41 loc) · 2.02 KB
Raw
合入代码须知
1. 必须在change_log.md中记录变更的内容，解决了什么问题，记录格式见: 变更日志
2. 如果有SQL变更，必须在update.sql尾部中进行追加记录，记录格式见: SQL变更
3. 增加新功能，须在doc对应的文档下进行使用说明，提供示例说明
   - (1)动作新增或变动，在action_design.md中记录，在可参考已有的说明格式，模板使用说明.yml文档按需增加说明
   - (2)断言新增或变动，在assert_design.md中记录，可参考已有的说明格式，模板使用说明.yml文档按需增加说明
   - (3)参数新增或变动，在parameter_design.md中记录，可参考已有的说明格式，模板使用说明.yml文档按需增加说明
4. 合入新代码，请进行自验，若未自验，请在变更日志中进行说明
5. 合入新代码，若是临时方案，请在变更日志中进行说明
6. 新增函数，命名请按实际功能英译，命名遵循行业规范
变更日志
20XX年0X月XX日 
序号：[Type] #问题单号或需求或优化单号 XXXX

Type类型：
1. Bug: 表示为已合入的功能，有代码类问题
2. Optimize： 表示已合入的功能，进行一定的易用性或逻辑上的优化
3. Feature: 表示合入新的功能

说明：#问题单号或需求或优化单号 根据实际填写，若无相关的编号，可省略

例如：

##### 20XX年0X月XX日
1. [Bug] #5459679 控制台-场景域运行的场景，场景测试历史环境类型不对，为赋值错误导致
2. [Optimize] #6423134 场景列表，编辑关联数据文件时，可单行编辑，数据文件支持上下移动
3. [Feature] #4654561 任务列表，关联数据，关联场景改为单条编辑，并且支持上下移动
SQL变更
-- 20XX年0X月XX日
SQL语句1;
SQL语句2;
例如
-- 2021年9月1日
alter table scene_data change yaml file_name longtext null comment '文件名称';
alter table scene_data change json content longtext null comment '文件内容';