diff --git a/CodeCommitChecklist.md b/CodeCommitChecklist.md index 4a4ddc738bedd9908562e99265cb7bbefcfcf734..e531a14f92ccfc181b838e2e8aa365a617b7786a 100644 --- a/CodeCommitChecklist.md +++ b/CodeCommitChecklist.md @@ -85,9 +85,43 @@ Signed-off-by: jiangwensai ## ReadMe编写规范 -1. 简介:介绍sample的具体功能,附上主要功能的屏幕截屏或者视频; -2. 相关概念:需要介绍本sample的主要实现原理,如使用了什么API、有什么关键性的配置和实现等等; -3. 相关权限:介绍应用的使用权限; -4. 使用说明:介绍应用的操作步骤和使用方法; -5. 依赖: 介绍对其他sample的依赖,附上sample链接 -6. 约束与限制:说明应用的运行操作系统版本、IDE版本、API版本等信息; \ No newline at end of file +1. 标题:以特性名称命名; +2. 介绍: + + 2.1 介绍sample的具体功能; + + 2.2 需要介绍本sample的主要实现原理,如使用了什么API、有什么关键性的配置和实现等等; + + 2.3 介绍应用的使用说明,具体的操作步骤和用法信息; + +3. 效果预览:屏幕截屏或者视频,文件不超过4个; +4. 相关权限:介绍应用的使用权限,附上链接; +5. 依赖: 介绍对其他sample的依赖,附上sample链接; +6. 约束与限制: + + 6.1 支持应用运行的操作系统版本和设备,示例如下: + + 本示例仅支持标准系统上运行,支持设备:RK3568; + + 6.2 API版本、SDK版本(如果依赖Full SDK,附上替换链接),示例如下: + + 本示例进支持APIXX版本SDK,版本号:3.X.X.X;(如果涉及Full SDK还需加上:本涉及涉及使用系统接口:XXX,需要手动替换Full SDK才能编译通过,具体操作可参考[替换指南]。) + + 6.3 支持的IDE版本,示例如下: + + 本示例需要使用DevEco Studio 3.0 Beta3 (Build Version: 3.0.0.901, built on May 30, 2022)版本进行编译; + + 6.4 高等级APL特殊签名说明,示例如下: + + 本示例涉及[相关权限]为system_basic(或者system_core)级别(相关权限级别可通过[权限定义列表]查看),需要配置高权限签名,可参考[特殊权限配置方法]; + +## UI自动化用例编写规范 + +1. 用例命名规范为:“包名_测试类名_序号”,如“MyApp_Index_001”; +2. 用例的开头和结尾都需要有日志打印,打印必须包括用例名称的关键字,示例: +```ts + console.info("MyApp_Index_001, begin") + ... + console.info("MyApp_Index_001, end") +``` +3. 用例中每条断言语句前必须添加日志,打印参数信息;