Skip to content

关于如何提交翻译以及后续更新的教程

Hoarfroster edited this page May 6, 2021 · 13 revisions

本教程主要面向新接触 GitHub 的译者们,为了更方便的完成翻译任务而写。注意,本教程基于 GitHub 网页版操作。

1. 认领任务

先在 Issue 列表 中挑选自己喜欢的文章进行认领。

2. Fork 掘金仓库

注意:如果你之前有 Fork 过,请跳过这一步。并在开始翻译之前先 同步 一下掘金仓库,否则无法找到认领的文章。

如果你之前有 Fork 过,现在需要继续翻译新文章,请在开始翻译之前先 同步 一下掘金仓库,否则无法找到认领的文章。

现在 GitHub 支持直接在网页上 Fetch and Merge,并且不会留下任何痕迹~

Fetch and Merge on GitHub

访问掘金翻译计划仓库的主页,并 Fork 到自己的账号下。

3. 进入 Fork 的仓库主页

回到自己的 GitHub 主页,并找到刚刚 Fork 过的掘金仓库,进入仓库主页。例如,我的即是 github.com/sqrthree/gold-miner

4. 新建 branch

现在你需要新建一个用于翻译一篇文章的 branch,先用鼠标左键单击 1 号箭头指向的位置,然后在 2 号箭头指向的地方填写新分支名称,我们推荐的新分支名格式为:translation/文件名,填写好后就会出现如 3 号箭头所示的东西,这时用鼠标左键单击它,新 branch 就建立好了,并且现在已经自动跳转到了这个新的 branch 上。

注:新建的分支用于进行翻译以及提交翻译。master 分支用于与掘金翻译计划进行同步更新。

image

5. 找到翻译的文章

image

在新分支的 TODO1 文件夹中找到翻译的文章对应的 Markdown 文件(PS:可通过文件名使用浏览器的快速搜索找到)。然后点击 Raw 查看原始内容,并右键另存为将其保存到本地。注:之前 Markdown 文件是在 TODO 文件夹,但是文件量过大(达到 1000),所以新文件已放在 TODO1 文件夹中。

5. 翻译文章

在你的电脑上找到刚刚保存的文件,使用编辑器打开,开始进行翻译,翻译时不需要保留英文原文,但是需要保留原有的 Markdown 标记,翻译的时候注意行号,一定要在原行进行翻译,不要随意换行,只有这样才能呈现良好而 commit 记录(如下图所示),方便后续的校对环节

image

6. 提交翻译

翻译完成之后,在你 Fork 的仓库中找到对应的你翻译的文章,然后点击编辑按钮,将你的译文复制进去并将原有内容覆盖掉。滚动到页面最下方,第一步填写 Commit changes 信息并提交,初次提交译文时请勾选 Commit directly to the translation/... branch.,之后点击 Commit changes 按钮进行提交。

麻烦所有译者千万不要在 Commit Message 中艾特别人!!!,不然提交以后每一个 fork 的 pull 都会艾特到这位同志!!!

image

7. 发起 Pull request

进行完第 6 步的提交之后,还在这个你 Fork 的 Repo 下点击 Pull requests 按钮,然后在页面右边会出现 New pull request 按钮,并点击它。

image

这时会自动跳转到掘金翻译计划的 Repo 下,接下来你按照下图的解释进行操作:

自此,翻译提交完成,请等待其他译者校对。

8. 根据校对意见进行调整

在自己的项目主页中先切换到第 6 步提交时新创建的分支(参考下图),然后在 TODO1 文件夹中找到自己翻译的文章,点击编辑按钮并根据校对意见进行调整。调整完成之后提交时请选择 Commit directly to the ... 直接进行提交。不要新创建分支也不要重新创建 PR,该次提交会自动同步至之前的 PR 下面。

image

image

自此,修改提交完成,这时你可以自我检查一遍,然后等待校对者和管理员进行校对和审核。


掘金翻译计划译者教程:

  1. 如何参与翻译
  2. 如何提交翻译以及后续更新
  3. 如何参与校对及校对的正确姿势
  4. 文章分享到掘金指南
  5. 译文排版规则指北
  6. 十万个为什么