中英文文档同步规则
发版文档升级时,同一逻辑内容的中英文文件必须成对修改、版本号一致。路径对照见 locale-map.md。
核心原则
- 只改
.md文件:版本升级禁止修改package.json、json5、js/ts、.tgz、图片等非 Markdown 文件。 - 版本真源唯一:所有文档中的 RNOH / RN / CLI / React 版本号,以
packages/下package.json为准(只读),不得凭记忆或旧文档复制。 - 成对更新:locale-map 中有英文对应路径的文件,同一 PR 内必须中英文一起改完;禁止只改
zh-cn留en旧号。 - 内容对应:release note、环境搭建等成对文档,章节结构、表格行数、变更条目数量应一致;英文是翻译对齐,不是另写一版。
- 缺口明示:locale-map 标注「仅中文 / 待英文」的文件,在变更报告中单独列出,不得静默忽略。
版本号写法
| 写法 | 格式 | 用于 |
|---|---|---|
| 版本线占位符 | 0.84.xx |
依赖安装、JSON 示例、环境搭建、编译指南、Samples README |
| 精确发版号 | 0.84.1 |
release note、版本索引 |
禁止将依赖示例中的 0.84.xx 改成 0.84.1。patch 发版时 release note 用精确号,依赖示例保持 0.84.xx。
版本字段对照(成对文件内必须相同)
| 字段 | 真源 | 典型出现位置 |
|---|---|---|
RN_VERSION |
packages/react-native-harmony/package.json → peerDependencies.react-native |
release note 用精确号;.md 依赖示例写 0.84.xx |
RNOH_VERSION |
同上 → version |
release note 表格用精确号;README 依赖示例写 0.84.xx |
CLI_VERSION |
packages/react-native-harmony-cli/package.json → version |
同上 |
REACT_VERSION |
根 package.json → react |
环境搭建 .md 内 JSON 示例(随 RN 版本线,通常与 RN 占位符一致) |
成对更新顺序(推荐)
对每个 locale-map 条目,按以下顺序操作,不要先改完全部中文再改英文:
1. 打开 zh-cn 与 en 成对文件(并排)
2. 在中文文件中定位需改的版本号 / 章节
3. 同步修改英文对应位置(版本号相同,仅语言不同)
4. 确认两侧 init 命令、JSON 块、表格版本列一致
5. 勾选该对在清单中「zh ✓ en ✓」
各文档类型双语要求
Release Notes(P0)
| 检查项 | zh-cn | en |
|---|---|---|
| 文件名 | release-notes/react-native-harmony-v{RNOH}.md |
同文件名 |
| 版本表格 | RNOH / CLI 版本号 | 相同数字 |
| 变更说明 | 新增 / 修复 / 不兼容 条目 | 条目数一致、语义对应 |
| 索引链接 | 05-运维/版本说明.md |
05-operations/release-notes-overview.md |
patch 发版:新建 v{新} 后,中英文各删被取代的旧 patch 文件(如 v0.84.0.md),索引两侧同步更新。
环境搭建 / Environment Setup(P0)
以下字段中英文必须相同,且使用 0.84.xx 占位符(非 0.84.1):
init AwesomeProject --version 0.84.xx- package.json 示例中的
"react-native": "0.84.xx"、@react-native/*": "0.84.xx" - 「基于社区 RN 0.84.xx」/「adapted from upstream RN 0.84.xx」
- API Level 说明可用「RNOH 0.84.xx 最低要求 API17」
Samples README(P1,写法同主文档)
| 文件 | 规则 |
|---|---|
README.md + README_zh.md |
依赖安装 @0.84.xx;大版本线变更时同步(如 0.82.xx→0.84.xx) |
| 禁止 | 将 0.84.xx 改成 0.84.1 |
| 同目录其他文件 | 禁止修改 |
| 步骤正文 | 禁止改步骤/编号/包管理器 |
仅中文、暂无英文全文
以下文件改版本时只改中文,并在报告中标注英文缺口:
RN升级需要开发者适配整理.mdRN应用鸿蒙化开发指南.md02-开发指南/编译构建/RNOH包使用指南.md05-运维/稳定性历史修复/**
英文侧 FAQ 若仅链接中文,确认链接仍有效即可。
双语验证命令
将 {RNOH}、{RN} 替换为真源版本后执行:
# 成对文件中的 RN 版本应一致
rg "0\.84\.\d+" docs/zh-cn/02-开发/01-环境与工具/环境搭建.md docs/en/02-development/01-environment-and-tools/environment-setup.md
# release note 索引最新条应相同
rg "RNOH v0\." docs/zh-cn/05-运维/版本说明.md docs/en/05-operations/release-notes-overview.md
# 不应存在已废弃 patch 的 release note(patch 升级后)
rg "react-native-harmony-v0\.84\.0" docs/
人工核对:对 locale-map 中每个 P0/P1 成对路径,确认 grep 命中行两侧版本号相同。
常见错误
| 错误 | 正确做法 |
|---|---|
只改 版本说明.md,漏 release-notes-overview.md |
索引文件成对改 |
| 中文 release note 有 5 条变更,英文只有 3 条 | 条目数与语义对齐 |
英文 environment-setup.md 仍写 0.84.0 |
与中文、peerDependencies 同步 |
将依赖示例 0.84.xx 改成 0.84.1 |
依赖/安装示例统一用 0.84.xx;精确号仅用于 release note |
| 认为 Samples 不用改 | major 时 Samples README 也要 0.82.xx→0.84.xx |