!1681 【轻量级 PR】:Add pr template

Merge pull request !1681 from steven_Q/N/A
This commit is contained in:
openharmony_ci 2024-03-07 15:10:37 +00:00 committed by Gitee
commit cf42635426
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F

View File

@ -0,0 +1,43 @@
### 该PR关联的issue
### 修改描述:
### 测试用例:
TDD/XTS/手工用例附上截图
### 日志规范自检:
| 自检项 | 自检结果 |
| ------------------------------------------------------------ | -------- |
| 【规则】高频代码的正常流程中禁止打印日志 | |
| 【规则】在基本不可能发生的点必须要打印日志 | |
| 【规则】事件记录的日志使用who do what 主谓宾的形式打印 | |
| 【规则】状态变化的日志打印使用state_name:s1->s2, reason:msg的形式打印 | |
| 【规则】参数值的日志打印使用name1=value1, name2=value2…的形式打印 | |
| 【规则】代码运行成功的日志使用xxx successful的形式打印 | |
| 【规则】代码运行失败的日志使用xxx failed, please xxx的形式打印且需包含可能的解决方案 | |
### 安全编码自检:
| 自检项 | 自检结果 |
| -------------------------------------------------------------- | -------- |
| 裸指针避免通过隐式转换构造为sptr | |
| json对象在取值之前必须先判断类型避免类型不匹配 | |
| 序列化时必须对传入的数组大小进行校验,避免出现超大数组 | |
| 避免使用未明确位宽的整型选择使用int8_t、uint8_t等类型 | |
| 外部传入的路径要做规范化校验,对路径中的.、..、../等特殊字符严格校验 | |
| 指针变量、表示资源描述符的变量、bool变量必须赋初值 | |
| readParcelable获取的对象使用前需要判空 | |
| 分配和释放内存的函数需要成对出现 | |
| 申请内存后异常退出前需要及时进行内存释放 | |
| 内存申请前必须对内存大小进行合法性校验 | |
| 内存分配后必须判断是否成功 | |
| 禁止使用realloc、alloc函数 | |
| 禁止打印文件路径、口令等敏感信息如有需要使用private修饰 | |
| 禁止打印内存地址 | |
| 整数之间运算时必须严格检查确保不会出现溢出、反转、除0 | |
| 禁止对有符号整数进行位操作符运算 | |
| 禁止对指针进行逻辑或位运算 | |
| 循环次数如果收外部数据控制,需要检验其合法性 | |
| 禁止使用内存操作类危险函数,需要使用安全函数 | |
| 谨慎使用不可重入函数 | |
| 必须检查安全函数的返回值,并进行正确处理 | |
| 禁止仅通过TokenType类型判断绕过权限校验 | |