From b21c3f5aa9a352a41b89f7eb427de76e1e2dd137 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9E=97=E5=98=89=E8=AF=9A?= <425765923@qq.com> Date: Sat, 16 Mar 2024 19:03:00 +0800 Subject: [PATCH] =?UTF-8?q?[Issues:=20#I993P6]=20=E6=9B=B4=E6=96=B0checkli?= =?UTF-8?q?st?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- zh-cn/repositories-release-checklist.md | 28 ++++++++++++---------- zh-cn/usage-docs-checklist.md | 32 ++++++++++++------------- 2 files changed, 32 insertions(+), 28 deletions(-) diff --git a/zh-cn/repositories-release-checklist.md b/zh-cn/repositories-release-checklist.md index 7f8b87e..2a7c859 100644 --- a/zh-cn/repositories-release-checklist.md +++ b/zh-cn/repositories-release-checklist.md @@ -6,15 +6,19 @@ ### Checklist -| 序号 | 内容 | 示例 | -| ---- | -------------------------------------- | ---------------------------------------- | -| 1 | JS 侧是否切换打补丁形式 | [react-native-linear-gradient](https://github.com/react-native-oh-library/react-native-linear-gradient)
https://github.com/react-native-oh-library/react-native-slider/tree/sig | -| 2 | package 是否升级版本 xxx | 3.0.0-0.0.1 => 3.0.0-0.0.2 | -| 3 | package 是否添加组织名 | react-native-linear-gradient => @react-native-oh-tpl/react-native-linear-gradient | -| 4 | package 是否配置 publishConfig | "publishConfig": { "registry": "https://registry.npmjs.org/", "access": "public" } | -| 5 | package file 是否配置鸿蒙相关目录文件 | "files": [ "harmony", "src", "index.d.ts", "index.harmony.js" ] | -| 6 | package 是否配置 repository | "repository": { "type": "git", "url": "https://github.com/react-native-oh-library/react-native-linear-gradient.git" } | -| 7 | package 是否配置原库依赖,实现打补丁方式 | 如@react-native-oh-tpl/react-native-linear-gradient 配置
"dependencies": { "react-native-linear-gradient": "3.0.0-alpha.1" }, | -| 8 | 发布 release 时,是否创建对应 tag | | -| 9 | 发布 release 时,是否添加 Fixes 和 Version Info | [react-native-linear-gradient Release](https://github.com/react-native-oh-library/react-native-linear-gradient/releases/tag/3.0.0-alpha.1-0.2.6) | -| 10 | 发布 release 时,是否添加 tgz 文件 | [react-native-linear-gradient Release](https://github.com/react-native-oh-library/react-native-linear-gradient/releases/tag/3.0.0-alpha.1-0.2.6) | +| 序号 | 内容 | 示例 | +| ---- | ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 1 | JS 侧是否切换打补丁形式 | [react-native-linear-gradient](https://github.com/react-native-oh-library/react-native-linear-gradient)
https://github.com/react-native-oh-library/react-native-slider/tree/sig | +| 2 | package 是否升级版本 xxx | 3.0.0-0.0.1 => 3.0.0-0.0.2 | +| 3 | package 是否添加组织名 | react-native-linear-gradient => @react-native-oh-tpl/react-native-linear-gradient | +| 4 | package 是否配置 publishConfig | "publishConfig": { "registry": "https://registry.npmjs.org/", "access": "public" } | +| 5 | package file 是否配置鸿蒙相关目录文件 | "files": [ "harmony", "src", "index.d.ts", "index.harmony.js" ] | +| 6 | package 是否配置 repository | "repository": { "type": "git", "url": "https://github.com/react-native-oh-library/react-native-linear-gradient.git" } | +| 7 | package 是否配置原库依赖,实现打补丁方式 | 如@react-native-oh-tpl/react-native-linear-gradient 配置
"dependencies": { "react-native-linear-gradient": "3.0.0-alpha.1" }, | +| 8 | 发布 release 时,是否创建对应 tag | | +| 9 | 发布 release 时,是否添加 Fixes 和 Version Info | [react-native-linear-gradient Release](https://github.com/react-native-oh-library/react-native-linear-gradient/releases/tag/3.0.0-alpha.1-0.2.6) | +| 10 | 发布 release 时,是否添加 tgz 文件 | [react-native-linear-gradient Release](https://github.com/react-native-oh-library/react-native-linear-gradient/releases/tag/3.0.0-alpha.1-0.2.6) | +| 11 | 鸿蒙版本和 js 版本是否一致 | 如 package 版本为 3.0.0-0.0.2,则 oh-package.json5 中的 version 也需要一致,修改需要更新到 har 和代码中 | +| 12 | 鸿蒙模块名是否规范 | oh-package.json5 中的 name 是否为 rnoh-xxx,使用 rnoh 代替原库 react-native 前缀,如果没有 react-native 前缀则直接添加 rnoh 前缀。
如:react-native-fast-image => rnoh-fast-image
Shopify/flash-list => rnoh-flash-list | +| 13 | 检查库是否添加平台判断 | 代码需要对标 IOS 进行移植,涉及 platform 代码、xx.ios.tsx 文件等,需要重点关注与修改,建议源码全局进行搜索检查 | +| 14 | 检查库是否测试完全所有暴露接口 | | diff --git a/zh-cn/usage-docs-checklist.md b/zh-cn/usage-docs-checklist.md index 0cf8d8a..54600ad 100644 --- a/zh-cn/usage-docs-checklist.md +++ b/zh-cn/usage-docs-checklist.md @@ -6,19 +6,19 @@ ### Checklist -| 序号 | 内容 | 示例 | -| ---- | ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| 1 | 是否按最新模板修改 | 参考每个文件夹中的 model.md | -| 2 | 是否修改模板号 | 模板版本:v0.1.2 | -| 3 | 是否填写 github 地址 | 位于模板版本下面:[!tip] Github 地址 | -| 4 | 是否未发布 | 如未 npm 发包,则补充 release 获取说明
**正在 npm 发布中,当前请先从仓库 Release 中获取库 tgz,通过使用本地依赖来安装本库。** | -| 5 | 安装方式是否配套 | 如已适配打补丁,则使用正常安装:
yarn add @react-native-oh-tpl/react-native-linear-gradient
未适配则需要使用覆盖安装:
配置名@npm:库名 | -| 6 | Link 路径是否配套 | 如已补丁整改的需要带上组织名:
file:../../node_modules/@react-native-oh-tpl/lottie-react-native/harmony/lottie.har | -| 7 | ArkTs 引入是否配套版本 | 如 rnoh 0.72.11 版本需使用 ctx.componentName 和 ctx.tag | -| 8 | 是否添加权限限制 | 如 fastimage 需要网络权限才可加载网络图片,则需要特别说明。 | -| 9 | 属性章节是否平台说明 | "Platform"列表示...
"HarmonyOS Support"列为 yes... | -| 10 | 属性章节表格头是否使用英文头 | 参考模板 | -| 11 | 属性章节 Description 是否补充平台描述 | 如 lottie imageAssetsFolder 属性中提到 ios 和 android 平台,那么需要补充 HarmonyOS 描述。 | -| 12 | 遗留问题是否有 issue 跟踪 | | -| 13 | 开源协议是否和原库一致 | | -| 14 | 纯 JS 库是否补充有可支持版本 | | +| 序号 | 内容 | 示例 | +| ---- | ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| 1 | 是否按最新模板修改(重点) | 参考每个文件夹中的 model.md | +| 2 | 是否修改模板号 | 如模板版本:v0.1.3 | +| 3 | 是否填写 github 地址 | 位于模板版本下面:[!tip] Github 地址,地址使用鸿蒙化仓库地址,若不需要鸿蒙化则填原库地址。 | +| 4 | 无修改的库是否指定版本 | 直接可复用社区代码,不涉及各类平台(platform、文件后缀等)判断的库,需要指定验证的版本 | +| 5 | 是否列全所有暴露属性 | 参考文档和代码 export 项,在文档中把所有开发者可用属性都写全,并且讲不支持的在 remark(备注)列说明原因,如仅 android 支持可不必说明。 | +| 6 | Link 路径是否配套 | 如已补丁整改的需要带上组织名:
file:../../node_modules/@react-native-oh-tpl/lottie-react-native/harmony/lottie.har | +| 7 | ArkTs 引入是否配套版本 | 如 rnoh 0.72.11 版本需使用 ctx.componentName 和 ctx.tag | +| 8 | 是否添加权限限制 | 如 fastimage 需要网络权限才可加载网络图片,则需要特别说明。 | +| 9 | 属性章节是否平台说明 | "Platform"列表示...
"HarmonyOS Support"列为 yes... | +| 10 | 属性章节表格头是否使用英文头 | 参考模板 | +| 11 | 属性章节 Description 是否补充平台描述 | 如 lottie imageAssetsFolder 属性中提到 ios 和 android 平台,那么需要补充 HarmonyOS 描述。 | +| 12 | 遗留问题是否有 issue 跟踪 | | +| 13 | 开源协议是否和原库一致 | | +| 14 | 纯 JS 库是否补充有可支持版本 | | -- Gitee