模块审核规范-H5

2022-06-06 17:04 更新

本文档适用于使用Html5开发的模块

  以下为APICloud平台技术人员在审核开发者提交的模块时的参考标准,模块开发者应熟悉这些标准,并且在提交模块之前,参考这些标准自审模块,减小被驳回的概率,提升效率,共同保障模块的品质。

2.1 运行审核

  开发者提交的H5模块,必须是可直接在标准手机浏览器或者AppLoader环境下运行的代码,运行入口应为1.1模块包及结构中所约定的入口html文件或者test.html文件,同时运行效果需与readme.md文档或者模块运行截图一致。

如模块包代码无法运行,或者运行效果和功能与描述不一致,一律驳回

2.2 最外层目录审核

  模块包的最外层目录必须为该模块的模块名,如rongChatList,且必须使用zip压缩工具将该目录压缩成zip格式文件(将windows下的rar格式后缀名改为zip属于无效格式)。如下图:

凡不符合此规范,一律驳回并指导开发者做修改

2.3 子目录或文件审核

  模块包内部子目录原则上遵循widget目录命名规范和文件归纳,不做特殊要求,但不允许有汉字或者大写字母命名的文件夹。

如开发者提交的模块包中,包含汉字或者大写字母命名的目录,一律驳回并指导开发者做修改

2.4 命名规范审核:

  原则上需要对模块包中所有文件,依据1.2命名规范中的要求进行命名规范的审核。

  该审核为非强制,如果开发者模块资源命名不规范,可做引导性指导修正。目的在于防止潜在的模块冲突问题

2.5 readme.md文件审核

  readme.md为标准的Markdown语法文件,可为使用者快速提供帮助参考,同时也有利于模块Store在特定的位置展示该文档。

一个全面的readme.md文件参考如下:

# 功能描述


    描述…


# 依赖的模块


    module1、module2 …


# 快速使用


    使用流程描述,API描述,代码更改定制帮助等…


# 特别说明


    使用本模块需要特别注意的地方,或者可能存在哪些问题,技术支持、帮助信息等

结合以上信息,readme.md审核时,应该满足以下规范:

2.5.1 功能描述

  功能描述为必须项,需清晰的描述该模块具备的功能或者提供的效果。

如描述模糊或者无法理解,一律驳回并要求开发者做修改

2.5.2 依赖的模块

  此项为可选项,如果本H5模块不依赖其他原生模块,可为空。

如此项为空,而在运行测试过程中发现报找不到模块的错误,一律驳回并指导开发者做更改

2.5.3 快速使用

  此项是重要项,开发者需要清晰的描述本模块的使用流程,开放API,可定制的代码访问等

如此项为空,或者描述模糊、无法理解等,一律驳回并要求开发者做修改

2.5.4 特别说明

  此项不做强制审核。

2.6 封面及运行截图审核

  模块封面图必须是具备审美设计的图片,不应为随意生成的粗糙图片;模块需至少提供2张运行截图。

如封面图存在明显低劣或者未提供2张及以上运行截图,一律驳回

以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号