diff --git "a/\344\273\243\347\240\201\346\217\220\344\272\244\350\247\204\350\214\203.md" "b/\344\273\243\347\240\201\346\217\220\344\272\244\350\247\204\350\214\203.md" new file mode 100644 index 0000000000000000000000000000000000000000..e24bf28900095f54a0beacbba55ff2fb49b3fadc --- /dev/null +++ "b/\344\273\243\347\240\201\346\217\220\344\272\244\350\247\204\350\214\203.md" @@ -0,0 +1,52 @@ +# 代码提交规范 + + 1. 所有文件,包括自动生成的编译文件package.json都要格式化; + 2. 函数命名,C++大驼峰,TS、JS小驼峰,方法命名注意动宾结构; + 3. 变量命名,必须见名知意,ArrayList类型直接按复数表示,不要带list; + 4. 函数参数命名,要规范化,见名知意; + 5. if语句后必须跟“{”,哪怕只有一行代码; + 6. 有break或return的条件,先break或return再走其他的逻辑; + 7. 条件判断,当一个分支达成条件时及时返回,不需要再走其他分支; + 8. 魔鬼数字要注意; + 9. 字符串拼接使用模板字符串; + 10. 组件使用,除了宽高属性可以在一行,其他的属性必须换行; + 11. 统一“;” ,TS、JS中统一不带; + 12. 字符串和图片资源等的使用,支持$r使用的,全部在reource中,使用$r引用; + 13. 新增文件注意开源协议、版权检查; + 14. 截图要使用真机效果图; + 15. readme中使用“.”,不要用“、”,检查错别字; + 16. 异步方法中需要返回方法的返回值,不用声明变量,直接return ,例如: return await this.mediaTest.getFileAssets(fetchOp); + 17. 方法中的参数需要类型声明; + 18. import 文件顺序,同类型放一起; + 19. string.json中description要写简要描述,zh下要用中文; + 20. TS、JS语言缩进为2格,C++语言缩进为4格; + 21. 涉及应用截图时,图片不能包含人物、关键信息、网络等有侵权风险的资源; + 22. 工程中不要配置签名信息; + 23. 代码文件中需要包含LICENSE信息; + +# PR提交格式规范 + +示例如下: +``` + IssueNo: #I56EH7:【MR】支持窗口属性设置 + Description: set wake up screen. + Sig: SIG_Sample + Feature or Bugfix: Bugfix + Binary Source: No + + Signed-off-by: jiangwensai +``` + + 1. IssueNo管理issue信息; + 2. Description描述修改变更内容; + 3. Sig统一使用SIG_Sample; + 4. Feature or Bugfix,如果是需求选择Feature,问题选择Bugfix; + 5. Signed-off-by,注明开发者账号和邮箱; + +# ReadMe编写规范 + + 1.简介:介绍sample的具体功能,附上主要功能的屏幕截屏或者视频; + 2.相关概念:需要介绍本sample的主要实现原理,如使用了什么API、有什么关键性的配置和实现等等; + 3.相关权限:介绍应用的使用权限; + 4.使用说明:介绍应用的操作步骤和使用方法; + 5.约束与限制:说明应用的运行操作系统版本、IDE版本、API版本等信息; \ No newline at end of file