diff --git a/.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md b/.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md new file mode 100644 index 0000000000000000000000000000000000000000..b6489667c28d090fc3f6bcbcb2a6670e85d687a6 --- /dev/null +++ b/.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md @@ -0,0 +1,48 @@ +### 关联的issue: + +### 修改描述(修改功能描述,规格变更说明): + +### 测试用例(附上截图,不涉及不需要说明不涉及原因): +1、TDD: + +2、XTS: + +3、手工用例(自验证步骤/预期结果/实际结果): + +### 兼容性上库自检: +- [ ] 不涉及API功能发生变化 +- [ ] 不涉及改变回调函数或生命周期的触发时机或时序,或删除生命周期和回调函数 +- [ ] 不涉及参数的规格发生了变化,例如取值范围缩小等 +- [ ] 不涉及对外接口新增权限校验 +- [ ] 不涉及接口的使用约束规格收紧 +- [ ] 不涉及系统可创建的实例数量收紧 +- [ ] 不涉及修改了接口返回的数据 +- [ ] 未新增错误抛出,包括新增错误码、对已有的场景从不会抛错误码变成会抛出错误 +- [ ] 未修改已有的错误码,对于相同的输入原本抛出A错误码变成了抛出B错误码 +- [ ] 接口性能未出现明显劣化 + +### 安全编码自检: +- [ ] 裸指针避免通过隐式转换构造为sptr +- [ ] json对象在取值之前必须先判断类型,避免类型不匹配 +- [ ] 序列化时必须对传入的数组大小进行校验,避免出现超大数组 +- [ ] 避免使用未明确位宽的整型,选择使用int8_t、uint8_t等类型 +- [ ] 外部传入的路径要做规范化校验,对路径中的.、..、../等特殊字符严格校验 +- [ ] 指针变量、表示资源描述符的变量、bool变量必须赋初值 +- [ ] readParcelable获取的对象使用前需要判空 +- [ ] 分配和释放内存的函数需要成对出现 +- [ ] 申请内存后异常退出前需要及时进行内存释放 +- [ ] 内存申请前必须对内存大小进行合法性校验 +- [ ] 内存分配后必须判断是否成功 +- [ ] 禁止打印文件路径、口令等敏感信息,如有需要,使用private修饰 +- [ ] 禁止打印内存地址 +- [ ] 整数之间运算时必须严格检查,确保不会出现溢出、反转、除0 +- [ ] 禁止对有符号整数进行位操作符运算 +- [ ] 循环次数如果收外部数据控制,需要检验其合法性 +- [ ] 必须检查安全函数的返回值,并进行正确处理 + +### 日志规范自检: +- [ ] 【规则】高频代码的正常流程中禁止打印日志 +- [ ] 【规则】在基本不可能发生的点必须要打印日志 +- [ ] 【规则】事件记录的日志使用who do what 主谓宾的形式打印 +- [ ] 【规则】状态变化的日志打印使用state_name:s1->s2, reason:msg的形式打印 +- [ ] 【规则】参数值的日志打印使用name1=value1, name2=value2…的形式打印