From 6dd0a3912b990d2fcc9e6ec94f30c825639724cd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9E=97=E5=98=89=E8=AF=9A?= <425765923@qq.com> Date: Tue, 9 Jan 2024 18:30:56 +0800 Subject: [PATCH] =?UTF-8?q?[Issues:=20#I8UUYX]=20=E6=96=B0=E5=A2=9Echeckli?= =?UTF-8?q?st=E7=AB=A0=E8=8A=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _sidebar.md | 5 +++++ zh-cn/repositories-release-checklist.md | 20 ++++++++++++++++++++ zh-cn/usage-docs-checklist.md | 24 ++++++++++++++++++++++++ 3 files changed, 49 insertions(+) create mode 100644 zh-cn/repositories-release-checklist.md create mode 100644 zh-cn/usage-docs-checklist.md diff --git a/_sidebar.md b/_sidebar.md index c34b57a..fec99f9 100644 --- a/_sidebar.md +++ b/_sidebar.md @@ -31,6 +31,11 @@ - [发布三方库到 Github Packages](zh-cn/github-package.md) - [发布三方库到 NPM 官方仓](zh-cn/npm.md) +- checklist + + - [发布 release checklist](zh-cn/repositories-release-checklist.md) + - [usage-docs checklist](zh-cn/usage-docs-checklist.md) + - 其他 - [常见问题 Q&A](zh-cn/qa.md) diff --git a/zh-cn/repositories-release-checklist.md b/zh-cn/repositories-release-checklist.md new file mode 100644 index 0000000..7f8b87e --- /dev/null +++ b/zh-cn/repositories-release-checklist.md @@ -0,0 +1,20 @@ +# 发布 Release Checklist + +### 简介 + +在仓库发布 release 版本时,请自行对照如下表格进行检查。 + +### 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) | diff --git a/zh-cn/usage-docs-checklist.md b/zh-cn/usage-docs-checklist.md new file mode 100644 index 0000000..0cf8d8a --- /dev/null +++ b/zh-cn/usage-docs-checklist.md @@ -0,0 +1,24 @@ +# 文档 Checklist + +### 简介 + +在提交 usage-docs 文档时,请自行对照如下表格进行检查。 + +### 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 库是否补充有可支持版本 | | -- Gitee