模塊審核規(guī)范-H5

本文檔適用于使用Html5開發(fā)的模塊

??以下為APICloud平臺技術人員在審核開發(fā)者提交的模塊時的參考標準，模塊開發(fā)者應熟悉這些標準，并且在提交模塊之前，參考這些標準自審模塊，減小被駁回的概率，提升效率，共同保障模塊的品質(zhì)。

2.1 運行審核

??開發(fā)者提交的H5模塊，必須是可直接在標準手機瀏覽器或者AppLoader環(huán)境下運行的代碼，運行入口應為1.1模塊包及結構中所約定的入口html文件或者test.html文件，同時運行效果需與readme.md文檔或者模塊運行截圖一致。

如模塊包代碼無法運行，或者運行效果和功能與描述不一致，一律駁回

2.2 最外層目錄審核

??模塊包的最外層目錄必須為該模塊的模塊名，如rongChatList，且必須使用zip壓縮工具將該目錄壓縮成zip格式文件（將windows下的rar格式后綴名改為zip屬于無效格式）。如下圖：

凡不符合此規(guī)范，一律駁回并指導開發(fā)者做修改

2.3 子目錄或文件審核

??模塊包內(nèi)部子目錄原則上遵循widget目錄命名規(guī)范和文件歸納，不做特殊要求，但不允許有漢字或者大寫字母命名的文件夾。

如開發(fā)者提交的模塊包中，包含漢字或者大寫字母命名的目錄，一律駁回并指導開發(fā)者做修改

2.4 命名規(guī)范審核：

??原則上需要對模塊包中所有文件，依據(jù)1.2命名規(guī)范中的要求進行命名規(guī)范的審核。

??該審核為非強制，如果開發(fā)者模塊資源命名不規(guī)范，可做引導性指導修正。目的在于防止?jié)撛诘哪K沖突問題

2.5 readme.md文件審核

??readme.md為標準的Markdown語法文件，可為使用者快速提供幫助參考，同時也有利于模塊Store在特定的位置展示該文檔。

一個全面的readme.md文件參考如下：

## 功能描述


    描述…


## 依賴的模塊


    module1、module2 …


## 快速使用


    使用流程描述，API描述，代碼更改定制幫助等…


## 特別說明


    使用本模塊需要特別注意的地方，或者可能存在哪些問題，技術支持、幫助信息等

結合以上信息，readme.md審核時，應該滿足以下規(guī)范：

2.5.1 功能描述

??功能描述為必須項，需清晰的描述該模塊具備的功能或者提供的效果。

如描述模糊或者無法理解，一律駁回并要求開發(fā)者做修改

2.5.2 依賴的模塊

??此項為可選項，如果本H5模塊不依賴其他原生模塊，可為空。

如此項為空，而在運行測試過程中發(fā)現(xiàn)報找不到模塊的錯誤，一律駁回并指導開發(fā)者做更改

2.5.3 快速使用

??此項是重要項，開發(fā)者需要清晰的描述本模塊的使用流程，開放API，可定制的代碼訪問等

如此項為空，或者描述模糊、無法理解等，一律駁回并要求開發(fā)者做修改

2.5.4 特別說明

??此項不做強制審核。

2.6 封面及運行截圖審核

??模塊封面圖必須是具備審美設計的圖片，不應為隨意生成的粗糙圖片；模塊需至少提供2張運行截圖。

如封面圖存在明顯低劣或者未提供2張及以上運行截圖，一律駁回