Description
翻译流程
此流程遵循标准的 Github Flow,如已了解可直接略过。
整个翻译流程分为以下几个阶段:
- 认领阶段
- 翻译阶段
- 校对阶段
认领阶段
如未认领文档就直接翻译,容易出现撞车的情况。
因此,在翻译前务必进行任务认领。
认领任务,请到 Github Issues 选择想翻译的文档。翻译任务认领
选定要翻译的文档后,即可开始翻译。
翻译阶段
以 webpack 文档为例,如需对某篇文章进行翻译。
翻译过程中,可以参考 cn-bk 分支中 webpack 4 原有的内容。有不少文档与 webpack 4 重复,可以直接拷贝过来使用,但请注意格式和内容的准确性。
fork 并 clone
先将 webpack 的文档仓库 fork 为个人仓库(有增删改的权限)。
将 fork 后的仓库 download 至本地,如:
git clone https://github.com/<YOUR-GITHUB-NAME>/webpack.js.org/
如下载过程过慢,可使用 depth
忽略以往的提交,这里不做过多赘述。
请基于 cn
分支创建你的翻译分支(目的是,保证 cn
分支与主仓库内容始终一致)。
例如:
git checkout -b <翻译分支>
翻译
ps: 在开始翻译前,请务必先了解中文排版说明以及与 webpack 相关的词汇表。
在 clone 好的文档中找到你所认领的文章,即可开始翻译。
翻译中请务必注意排版规范,尽量不要让校对者在文档格式方面浪费时间。
翻译完成后,请 push 至个人仓库。
git add
git commit -m 'docs(cn): translate <文档的详细路径>'
git push -u origin <翻译分支>
再创建 Pull Request 至 webpack 的中文仓库。
注意:在创建 Pull Request 时,请尽量勾选允许其他人进行修改,便于快速修改及合并。
至此翻译阶段就结束了。
校对阶段
翻译完成请通知校对者,可在 PR 中添加 Reviewers。
- QC-L
- dear-lizhihua
- lcxfs1991
- yuqingc
- Yucohny
校对中,如有疑问或翻译错误,校对者会给出建议。
Github 的 PR 的评论提供了 suggestion 的功能,校对者对某行给出校对建议后,如无异议,可以直接进行合并。
而如果改动点较多,需进行本地修改时,则在本地对对应的内容进行修改,并提交到个人仓库的翻译分支即可。
注意: 无需关闭 Pull Request,Pull Reuquest 会自动追踪你的修改。
完成
校对完成后,校对者会对 PR 进行 Approve 操作,并进行 Pull Request 的合并。
当你的 Pull Request 被合并后,则代表流程结束。
其他
如需再次翻译,或同时翻译多篇。
- 一次 pr 尽量只有一篇文章的翻译,便于回溯
- 保证个人仓库的 cn 分支始终为最新
- 每次翻译新文章时,请基于 cn 分支拉取新分支
更新个人仓库的分支
git remote add upstream https://github.com/docschina/webpack.js.org.git
git fetch upstream
git checkout cn
git merge upstream/cn