Huawei LiteOS（以下简称LiteOS）欢迎开发者参与到开源社区的贡献中来，本文主要介绍参与LiteOS文档贡献的写作规范，如果贡献者提交文档的修改或提交新的文档，请参照此规范。如需提交新的文档，在LiteOS代码仓doc目录下创建新的.md文件，命名需遵循xxx_xxx.md格式，根据文档的内容来声明。比如介绍写作规范的文档，

查看更多 →

签名审核规范 格式限制 签名名称不能含有黄赌毒及其他违反法律规定的信息； 签名不支持中性化签名，需能辨别所属公司或公司归属的网站、产品、APP； 国内短信签名由【】及签名名称组成，签名名称要求2~12个字（只能包含中文、数字、字母，不能为纯数字，国内短信签名名称尽量使用中文）；

查看更多 →

异形字、语句不通顺、非常用的表达法等。 如遇到违反规范并造成恶劣影响的，将严肃处理并进行封号。请严格遵守规范要求，加强自身业务安全，健康发送短信。 内容规范可能随运营商规则变化实时调整，以最终 内容审核 结果为准。 父主题： 审核规范

查看更多 →

设计规范 命名规范 数据库对象（库名、表名、字段名、索引名）命名建议全部使用小写字母开头，后面跟字母或者数字，数据库对象（库名、表名、字段名、索引名）名字长度建议都不要大于32字节。 数据库名称不能使用特殊字符("",.,$,\,/,*,?,~,#,:,|")和空字符\0，数据库

查看更多 →

构造规范请求 使用AK/SK方式进行签名与认证，首先需要规范请求内容，然后再进行签名。客户端与云服务API网关使用相同的请求规范，可以确保同一个HTTP请求的前后端得到相同的签名结果，从而完成身份校验。 HTTP请求规范伪代码如下： CanonicalRequest =

查看更多 →

DDL操作规范 建议3.1 DDL操作（CREATE除外）避免在业务高峰期和长事务中执行 违反规范的影响： DDL操作普遍持锁级别高，如ALTER、DROP、TRUNCATE、REINDEX、VACUUM FULL等，执行时会造成业务等锁阻塞。 高峰期执行持锁级别高的DDL操作，造成业务等锁阻塞。

查看更多 →

实例使用规范 数据库连接 RDS for PostgreSQL是进程架构，每个客户端连接都对应一个后端服务进程。 根据业务的复杂度，合理配置“max_connections”，例如，参考pgtune： WEB应用：“max_connections ”配置为 200 OLTP应用：

查看更多 →

实例使用规范 数据库实例 数据库实例类型选择 主备 一主一备的经典高可用架构。适用于大中型企业的生产数据库，覆盖互联网、物联网、零售电商、物流、游戏等行业应用。 备机提高了实例的可靠性，创建主机的过程中，同步创建备机，备机创建成功后，用户不可见。 当主节点故障后，会发生主备切换，

查看更多 →

。 检查用例规范性 用户可以对创建的手工测试用例进行规范检查，根据检查结果对用例进行优化。详细的编写规范请参考测试用例编写规范。 此功能为您提供65天试用期，后续需要开通测试计划专业版套餐或CodeArts专业版以上套餐来延续您的高阶体验。 完成编写测试步骤后，在页面下方单击“规范检查”，检查结果将显示在页面下方。

查看更多 →

模板规范和变量规范包含哪些内容？ 模板规范 模板规范分为模板格式规范和模板内容规范。 模板格式规范 文本短信模板限500字符。 不支持使用【】，【】可能会与签名混淆，导致发送失败。 不支持使用特殊符号，如￥、★、^_^、&、√、※、[]等，特殊符号可能会导致短信出现乱码。 模板内容规范

查看更多 →

。 *.vue：用于定义Vue组件，包括模板（HTML）、脚本（JavaScript）和样式（ CSS ）。 组件协议结构规范 组件协议结构规范用于描述组件的关键信息和配置项，对应组件的components字段。 表1 组件协议结构规范 字段 说明 类型 name 组件名称，以“i18n”形式配置。

查看更多 →

目前，社区有多种 Commit message 的写法规范。LiteOS采用的是Angular规范，这是目前使用最广的写法，比较合理和系统化，并且有配套的工具。格式化的Commit message有几个好处：提供更多的历史信息，方便快速浏览。可以过滤某些commit（比如文档改动），便于快速查找信息。可以直接从commit生成Change

查看更多 →

服务包规范 本规范主要面向对象为初次开发的服务以及想要使用OSC平台提供的附加能力进行规范转换的服务。 如果开发者已有或仅想使用Helm/Operator-Framework规范的服务，可以直接参考章节开源服务包规范。 OSC服务包介绍 元数据Metadata 资源集合Manifests

查看更多 →

#【必选】CustomResourceDefinition自定义资源定义文件，可多个。 更多介绍参见官网Operator Framework。 接入规范说明 父主题： 开源服务包规范

查看更多 →

接入规范说明 开源OLM服务（operator-framework）服务支持自定义配置服务场景、支持架构等配置，其描述说明定义在clusterserviceversion.yaml中，具体样例如下： apiVersion: operators.coreos.com/v1alpha1

查看更多 →

接入规范说明 开源helm服务支持自定义配置服务场景、支持架构等配置，其描述说明定义在Chart.yaml中，具体样例如下： apiVersion: v1 description: "nginx \n" maintainers: - email: support@rancher.com

查看更多 →

基础命令规范 查询命令 写入/更新命令 删除命令 父主题： 数据库使用规范

查看更多 →

设计规范 命名规范 数据库对象（库名、表名、字段名、索引名）命名建议全部使用小写字母开头，后面跟字母或者数字，数据库对象（库名、表名、字段名、索引名）名字长度建议都不要大于32字节。 数据库名称不能使用特殊字符("",.,$,\,/,*,?,~,#,:,|")和空字符\0，数据库

查看更多 →

SELECT操作规范 规则3.7 禁止执行不下推的SQL GaussDB (DWS)为分布式架构，SQL语句必须下推才能分利用分布式的计算资源，达到性能最优。 违反规范的影响： 不下推的SQL执行性能差，严重情况会导致CN资源瓶颈，影响整体业务。 方案建议： 不使用不下推的语法和不下推的函数，具体参考语句下推调优。

查看更多 →

单击“”，菜单内容中显示该样式的HTML代码，可以在此基础上进行编写代码，如图5所示。 图5 编辑代码 也可以不选择样式，选择自定义样式，编辑HTML内容，如图6所示。 图6 自定义代码 其余菜单样式、链接、属性等设置方法跟默认页面类型中的一致，可以参考默认页面类型。 单击右上角“保存”。

查看更多 →

以root用户登录docker所在的机器。 执行如下命令，切换到用于存放该应用的目录。 cd apptest 编写脚本文件，脚本文件名称和内容会根据应用的不同而存在差别。此处仅为本例应用的指导，请根据实际应用来编写。 vi start_tomcat_and_mongo.sh #!/bin/bash #

查看更多 →