osu! 中文翻译组织

工作流程

在介绍 osu! 中文翻译的翻译流程之前，我们假定你对 Git（分布式版本控制软件）和 Github（代码托管平台）有一定的了解。具体要求如下：

  • 理解 Github 的工作流（Workflow），明白 Repo，Branch，Pull Request，Review 的含义。
  • 会使用常用的 Git 命令，例如 git commit，git fetch，git checkout 等。

如果你还不了解的话，可以通过这些 学习资源 学习它们。

翻译流程

翻译流程的几个关键点是：

  • 翻译的 Pull request 是由自己的仓库到组织的仓库，当我们在组织内 Review 完成这篇翻译后，再从组织仓库 Pull request 到 ppy 仓库。 这是为了将中文和其他的语言的翻译 PR 分开，互不干扰，以及便于自由地使用中文进行评论。

  • 接下一篇翻译任务时，请在组织内新建一个对应的分支，这篇翻译的 Pull request 的目标分支请设置为这个分支。 因为一篇文章对应于一个分支，翻译完成后我们会将组织中的这个分支 Pull request 到 ppy 仓库。

  • 翻译之前，请在文件夹中复制一份 en.md 文件，并将它改名为 zh.md，作为第一个 Commit（Commit 信息为 zh: Init translation）。 这是为了方便以后 Review 的时候可以直接对照原文，例如：

files changed

简单来说，比如你想翻译 Guides 页面，你需要：

需要先在组织中建立一个 zh-guides 分支，然后 Fetch 组织仓库，新建一个本地分支，翻译文章，最后 Push 到自己的仓库中，Pull request 到组织仓库中。

下面详细讲解翻译流程：

  1. Fork 组织仓库。在 osu-translate-zh/osu-wiki 页面的右上角点击 Fork 即可。

  2. Clone 自己的仓库到本地。执行 git clone <你的仓库的 git url> 命令。

自己仓库的 Git url 可以在自己仓库的页面上找到。

clone url

  1. 在组织仓库中建立新的分支 zh-guides。

create branch

  1. Fetch 组织仓库，新建一个本地分支。 
    git remote add zh https://github.com/osu-translate-zh/osu-wiki.git
git fetch zh
git checkout -b zh-guides zh/zh-guides
  2. 现在你可以进行翻译工作，完成后进行 Commit，然后执行 Push 命令提交到自己的仓库。 
    git add .
git commit -m "update zh.md"
git push -u origin zh-guides

  3. 从自己的仓库 Pull request 到组织仓库。注意两个分支相对应。

  4. 进行 Review 工作，最后这个分支会被合并进组织的 zh-guides 分支中。

  5. 去 ppy 仓库 Pull request 这个分支。一般会很快被合并进 Master 分支。

你可以在 Issues 列表 中查看需要翻译的文章。

审阅流程

审阅别人的翻译，留下自己的意见和建议，也就是 GitHub 上的 Review 工作。

在一个 PR 中点击某个特定的 Commit 或者点击 Files changed，即可看到相关的修改。

鼠标移动到某行上，直接点击即可输入自己的评论（Comment）。

输入后请点击 start review 或 add review comment。

完成审阅后，点击评论框中的 Finish your review，可以在右上角的文本框中输入总结性的评论。

最后点击 Submit review，即完成了一次 Review。

你可以在 osu-translate-zh 的 Pull Request 列表 中查看需要审阅的 PR。

接管（甩锅）流程

某些时候，当原来的翻译者无法继续进行翻译，而需要新的翻译者来继续未完成的翻译工作时，应当这么做：

  1. 合并原来的未完成的 Pull request。
  2. 新翻译者 Fetch 组织仓库，在本地创建新的分支，继续进行翻译。
  3. 将这个本地分支推送到自己的仓库中，并 Pull request 到组织仓库。
  4. 按照正常的翻译流程继续进行。