ShenQingchuan/docs-next

如何更好地翻译

ShenQingchuan opened this issue · 1 comments

ShenQingchuan commented

原则

  1. 虽然 Vue 3 的文档采用了全新的架构，也有了许多新增内容，但有很大一部分仍然继承自原有的 Vue 2.x 文档。
    故我们要 尽最大可能 与 中文文档 保持一致。
    也就是说：你可以从原有文档中 复制、粘贴 很多已有的翻译。
  2. 翻译的目标是：”信，达，雅“
  • 即使是已有的翻译，也请 首先阅读一遍原英文，形成自己的理解，对比现存翻译是否有新增部分，若没有则请全盘保存现存翻译。（因为这是官方认可、审阅过地翻译）
  • 对于有任何拿不准的，值得讨论的地方，请在您领取任务后建立的「 单篇讨论帖 」issue 中发表出来，我们将持续关注与处理。
  1. 这是官方 composition-api 文档，如果翻译 Vue3 章节，一些措辞语句可以参考。
  2. 这是 cn.vuejs.org 给出的一些翻译规范、约定，比如 property 是保留的词 不需要翻译。

工作流程

如果您还不太熟悉 Git 和 Github 的相关核心概念（主要的有：commit，push，fork，PR (Pull Request)，issue）那么可能需要提前补补课...

  • 第一步：Fork 到自己的仓库
    点击 本仓库任意页面 右上角的 Fork 按钮，选择 Fork 到自己名下，Github 将会自动开始复制一份本仓库到你到仓库集中。

  • 第二步：Git Clone 并安装 NPM 依赖
    在你到 Fork 仓库 Code 页里，点击绿色的 Clone 按钮
    image
    然后复制地址，在你的电脑本地 Git bash 或是其他形式的终端（Terminal）中输入：git clone 复制的地址
    等待下载完成，在终端所在目录输入：（Linux / Mac 类终端 / Git bash）ls/ （Windows 命令行）dir 展示当前目录下的所有内容，即可以找到已存在该文件夹。

此时希望你能有基本的 Bash / 命令行 操作知识，使用 cd docs-next 切换进该文件夹。
然后执行 npm i 或 yarn 安装 NPM 依赖，若有任何问题，请删除 node_modules 文件夹再次尝试

  • 第二步附加（可选）：开启你的新分支：
    若你对 Git 的分支操作比较熟悉，你应该为每一次文章的翻译开启一个新的分支。

  • 第三步：使用 VSCode 或其他任意编辑器打开该文件夹
    按照你领取任务文章的 path 路径地址，在 src 文件夹下找到该文件开始翻译。

  • 第四步：翻译完成后，git push -u origin master 推送的目标远端 origin 应是你的 Fork 仓库。
    推送完成后检查一下你的 Fork 仓库，是否有新增的 commit 记录。

  • 第五步：来到这个主仓库中，创建新的 Pull Request 请求：

  1. 如果你采用了上述每次翻译都开启新分支的方案：
    你应该选择的合并是：shenqingchuan/master <-- your_name/your_branch
  2. 如果你只是简单在 master 分支上开发：
    你应该选择的合并是：shenqingchuan/master <-- your_name/master
  • 最后等待大家审阅，校对完成。
ShenQingchuan commented

image

这个绿色的 Block 以后我们统一将采用下面形式的小标题格式

::: info 提示

::: tip 注意

::: warning 警告

::: danger 危险

这个 Block 的具体配色请参考原文。