diff --git a/.gitee/PULL_REQUEST_TEMPLATE.en.md b/.gitee/PULL_REQUEST_TEMPLATE.en.md index 629fd4e6e77378c41e745608c95498bfe9439d54..c1d32f4de4d4b92b8e6e551d8477176217fbc9da 100644 --- a/.gitee/PULL_REQUEST_TEMPLATE.en.md +++ b/.gitee/PULL_REQUEST_TEMPLATE.en.md @@ -1,4 +1,4 @@ - + # Summary @@ -13,27 +13,4 @@ Explain the **motivation** for making this change: here are some points to help -- [ ] 是否按[最新模板](../zh-cn/model.md)修改； -- [ ] 是否修改模板号，当前最新版本为 v0.2.2； -- [ ] 是否填写 github 地址，位于模板版本下面:[!tip] Github 地址，地址使用 HarmonyOS 仓库地址，若不需要 HarmonyOS 化则填原库地址； -- [ ] 无修改的库是否指定版本，直接可复用社区代码，不涉及各类平台判断（platfrom、文件平台后缀等）的库，npm install & yarn add 需要指定验证的版本； -- [ ] 是否列全所有暴露属性和接口（含不支持的）； -- [ ] Link 路径是否配套； -- [ ] ArkTS 引入是否配套版本； -- [ ] 是否添加权限限制（如有）； -- [ ] 属性章节是否添加平台说明； -- [ ] 属性章节是否使用英文头； -- [ ] 属性章节 Description 是否补充平台描述； -- [ ] 兼容性章节是否区别了“发 release”和“未发 release”； -- [ ] 遗留问题是否有 issue 跟踪； -- [ ] 开源协议是否和原库原库一致（LICENSE）； -- [ ] 有引入原生端代码和依赖是否和 npm 的包名一致； -- [ ] API、静态方法、属性的表格是否按照模板的格式； -- [ ] 不支持属性是否有做问题遗留； -- [ ] 文档是否使用了 prettier 格式化； -- [ ] release 超链接的载体是否为完整库名 + Release; -- [ ] 兼容性模块 RNOH 的版本 0.72.20 以后的版本不需要加 CAPI； -- [ ] 使用 codegen 和直接链接源码的文档链接是否是相对路径； -- [ ] 文档里面的 demo 是否没有代码代码错误，直接可跑通； -- [ ] 文档名字是否以 npm 包名为准； -- [ ] fabric 库是否有 “在 ArkTS 侧引入 xxx 组件”； +- [ ] 是否对照[usage-docs-checklist](../zh-cn/usage-docs-checklist)的每一项进行检查 diff --git a/.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md b/.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md index 3a60d1cb158954a93d24d6605031c2266b0b1e6e..87ce9d88c892522df10284fbf8c3674b13d416e8 100644 --- a/.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md +++ b/.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md @@ -1,4 +1,4 @@ - + # Summary @@ -13,27 +13,4 @@ -- [ ] 是否按[最新模板](../zh-cn/model.md)修改； -- [ ] 是否修改模板号，当前最新版本为 v0.2.2； -- [ ] 是否填写 github 地址，位于模板版本下面:[!tip] Github 地址，地址使用 HarmonyOS 仓库地址，若不需要 HarmonyOS 化则填原库地址； -- [ ] 无修改的库是否指定版本，直接可复用社区代码，不涉及各类平台判断（platfrom、文件平台后缀等）的库，npm install & yarn add 需要指定验证的版本； -- [ ] 是否列全所有暴露属性和接口（含不支持的）； -- [ ] Link 路径是否配套； -- [ ] ArkTS 引入是否配套版本； -- [ ] 是否添加权限限制（如有）； -- [ ] 属性章节是否添加平台说明； -- [ ] 属性章节是否使用英文头； -- [ ] 属性章节 Description 是否补充平台描述； -- [ ] 兼容性章节是否区别了“发 release”和“未发 release”； -- [ ] 遗留问题是否有 issue 跟踪； -- [ ] 开源协议是否和原库原库一致（LICENSE）； -- [ ] 有引入原生端代码和依赖是否和 npm 的包名一致； -- [ ] API、静态方法、属性的表格是否按照模板的格式； -- [ ] 不支持属性是否有做问题遗留； -- [ ] 文档是否使用了 prettier 格式化； -- [ ] release 超链接的载体是否为完整库名 + Release; -- [ ] 兼容性模块 RNOH 的版本 0.72.20 以后的版本不需要加 CAPI； -- [ ] 使用 codegen 和直接链接源码的文档链接是否是相对路径； -- [ ] 文档里面的 demo 是否没有代码代码错误，直接可跑通； -- [ ] 文档名字是否以 npm 包名为准； -- [ ] fabric 库是否有 “在 ArkTS 侧引入 xxx 组件”； +- [ ] 是否对照[usage-docs-checklist](../zh-cn/usage-docs-checklist)的每一项进行检查； diff --git a/zh-cn/usage-docs-checklist.md b/zh-cn/usage-docs-checklist.md new file mode 100644 index 0000000000000000000000000000000000000000..e615ebb2d5cfc4edebbf81c1dbe00930ea004f2a --- /dev/null +++ b/zh-cn/usage-docs-checklist.md @@ -0,0 +1,33 @@ +# 文档 Checklist + +### 简介 + +在提交 usage-docs 文档时，请自行对照如下表格进行检查。 + +### Checklist + +| 序号 | 内容 | +| ---- | ----------------------------------------------------------------------------------------------------------------------------------------- | +| 1 | 是否按[最新模板](./zh-cn/model.md)修改 | +| 2 | 是否修改模板号，当前最新版本为 v0.2.2 | +| 3 | 是否填写 github 地址，位于模板版本下面:[!tip] Github 地址，地址使用 HarmonyOS 仓库地址，若不需要 HarmonyOS 化则填原库地址 | +| 4 | 无修改的库是否指定版本，直接可复用社区代码，不涉及各类平台判断（platfrom、文件平台后缀等）的库，npm install & yarn add 需要指定验证的版本 | +| 5 | Link 路径是否配套 | +| 6 | ArkTs 引入是否配套版本 | +| 7 | 有引入原生端代码和依赖是否和 npm 的包名一致； | +| 8 | 是否添加权限限制（如有） | +| 9 | 属性章节是否平台说明 | +| 10 | 属性章节表格头是否使用英文头 | +| 11 | 属性章节 Description 是否补充平台描述 | +| 12 | 是否列全所有暴露属性和接口（含不支持的） | +| 13 | 不支持属性是否有做问题遗留； | +| 14 | 遗留问题是否有 issue 跟踪 | +| 15 | 开源协议是否和原库一致（LICENSE） | +| 16 | 有引入原生端代码和依赖是否和 npm 的包名一致 | +| 17 | API、静态方法、属性的表格是否按照模板的格式 | +| 18 | release 超链接的载体是否为完整库名 + Release | +| 19 | 使用 codegen 和直接链接源码的文档链接是否是相对路径 | +| 20 | 文档里面的 demo 是否没有代码代码错误，直接可跑通 | +| 21 | 文档名字是否以 npm 包名为准 | +| 22 | fabric 库是否有 “在 ArkTS 侧引入 xxx 组件” | +| 23 | 文档是否使用了 prettier 格式化 |