协作指南

Vue 3 官方中文文档协作指南

欢迎参与 Vue 3，以下内容适用于参与 vuejs/docs-next-zh-cn 仓库的协作，在此之前，你应该阅读过术语翻译约定。

1. 开始参与

• 安装 git
• 安装 nodejs
• 你应该具备一些 git 命令的知识
• 编辑、开发工具（建议 vscode ）

2. 开发

$ git clone https://github.com/vuejs/docs-next-zh-cn.git  # clone 仓库
$ npm install # 安装依赖（或yarn，国内用户可使用 [cnpm](https://cnpmjs.org/) ）
$ npm run serve # 启动开发环境，本地访问（http://localhost:8080）

在完成翻译后，发起 PR 即可，review 无误后，将合并入主仓库

2.1 commit message 规范

具体规范参考

建议 message 使用英文，关键词后加英文冒号，再加空格，一段话描述，如：

• style: fix the strong style for Chinese characters
• chore: update yarn.lock
• review: introduction

3. 章节领取（校验）

先发起 issue，领取章节或校验章节

从“翻译进度” 认领章节发起新的 issue：

标题格式为（精确至文件定位），如：

• 认领未翻译：【翻译】：src/community/team.md
• 认领校对：【校对】：src/README.md

当你完成翻译或校对后，发起 PR，在 PR 的讨论中，附上 issue 地址，让我们知道你此 PR 的关联 issue ，并随时在上述 issue 中报告你的翻译进度。

4. 英文仓库同步实现

• 不对文件格式化，尤其是 .vue 文件
• 发起PR，需要备注对应英文hash。

5. 注意事项

5.1 如何使用 zhlint 工具

• 安装 zhlint

npm install zhlint -g # 或 yarn global add zhlint

• 使用 zhlint 查看

zhlint readme.md # 查看 `zhlint` 检测的结果

• 使用 zhlint 修复

zhlint readme.md --fix # 使用 `zhlint` 修复

5.2 review 汇总

• review: introduction

5.2.1 简写 “your...”

• 原文中出现的代码变量外通常需要加一对反引号
• 英文中经常出现“your ...”翻译的时候如果读起来够通顺，通常我们可以把“your”忽略掉，使得译法更精炼。比如“make your app faster”可以翻译为“让应用变得更快”
• 空格的使用：对于文本中间出现的英文，两侧都需要加空格。如“创建Vue 应用” -> “创建 Vue 应用”

6. 常见问题

6.1. 发现有些段落翻译晦涩难懂？ - 在搜索未得到相关讨论结果后，可发起 issue ，有结论后，我们定期汇总至 术语翻译约定 wiki

6.2. 如何发起 Pull Requests ？ - clone 仓库 - 更改完毕后，推送到自己的仓库 - 比较仓库，右侧为你的仓库和分支，左侧是需要并入的目标仓库和分支 - 选择比较的分支后，点击按钮：“Create pull request” 即可发起

6.3. 如何查看“我的贡献”？ - 点此查看贡献

6.4. 新发现一个新的特性，但没有被 “翻译进度” 收录？ - 可发起 issue 告诉我们

6.5. 发起 PR 的标题？ - 我们建议你使用英文作为标题，并简明扼要的概括，在该 PR 的评论中追加特性说明

6.6. 如果想在赞助本仓库？ - todo

6.7. 如果有一个章节很长，我只翻译了一半，后续不想翻译了？ - 虽然允许，但，我们还是建议你，最好以一个 .md 文件为单位来发起 PR，避免后续来回追踪。

6.8. 对于有原英文有自己的见解？ - 我们建议你到 英文仓库：vuejs/docs-next 讨论

6.9. 对于网站架构上有自己的见解？ - 非涉及到本地化内容，我们还是建议你到 英文仓库：vuejs/docs-next 讨论

6.10. 对于 Vue 技术的讨论？ - 对于 Vue 的使用答疑，请移步到各大技术社区讨论