-
Notifications
You must be signed in to change notification settings - Fork 4
翻译协作流程 v1
- 通过 issue 申请成为译者(暂不开放申请)
- 在 issue 中认领翻译任务
- Fork 项目仓库到个人账户
- 在个人仓库新建翻译分支
- 在翻译分支进行翻译
- 覆盖原内容提交翻译内容
- 发起 pull request 到主仓库
- 校对人员对翻译内容进行校对
- 译者根据校对意见进行修改
- 项目负责人进行最终审核
以下内容是关于一些步骤的详细说明,请务必仔细阅读。所有步骤以 GitHub 网页操作展示为主,如果你非常熟悉 git 协作流程和命令行,可以根据对应要求通过命令行来进行操作。
项目建立后负责人会通过 issue 的形式发布项目翻译认领说明,译者可以在对应 issue 中根据个人兴趣和能力选择认领相关的翻译内容。认领翻译内容后则正式进入翻译协作流程。
Fork 项目仓库到个人账号是整个协作中非常重要的一步,它便于项目负责人对所有译者的翻译提交申请进行管理。如下图所示,你可以在项目主页的右上角中点击 Fork
,仅需要很短的时间,你就可以根据页面提示跳转到自己个人账号下的对应项目中。
特别注意:一个项目只需要 fork 一次即可。如果你已经 folk 过该项目,请在开始正式翻译前务必再同步一次官方的项目仓库。 因为在你初次folk到开始翻译的这段时间内,可能官方的仓库内容已经发生了翻天覆地的变化。请一定记住,在开始正式翻译前务必再 同步 一次官方的项目仓库。
关于如何在不同的系统中同步 folk 内容,请参考 官方说明。如果你是一个初学者,我们建议你按照 此教程 通过网页完成同步过程。
进入自己 GitHub 主页 Fork 过的仓库,在个人项目中创建一个翻译分支 (Branch) 用来进行后续的翻译和提交工作。而一开始的主分支 (master) 则用于后续和官方的项目仓库进行进行同步。具体操作方法如下图所示:首先点击 Branch(1) ,然后在输入框(2)中输入分支名:translation_yourfilename,然后点击 Create branch(3)即可创建并进入到这个新的分支。
如下图所示,项目的原始文件通常都会存放于后缀为 _todo
的目录中且原始文件通常为包括 _en
后缀的 markdown 或者 Rmarkdwon 文件。如果一个内容本身又包含多个文本,则会再建立一个后缀为 _en
的目录用于存放若干文本。
接下来就是正式的翻译过程,你可以选择把自己要翻译的文本下载到本地,在本地选择自己喜欢的编辑器进行翻译。如果你需要翻译的文本为 Rmarkdown 格式(通常文件结尾为 Rmd
),强烈建议你使用 Rstudio 来当做自己的翻译编辑器。
关于如何进行翻译可以查看具体的翻译要求,在此只做两点特别提醒:
- 翻译无需保留英文原文,但务必保留所有的 markdown 标识符
- 翻译过程中不要随意修改换行,否则将给校对工作带来极大的不便
当你在本地完成翻译工作之后,接下来需要将其提交(commit)到前面 folk 的个人仓库中。你可以首先新建的翻译分支中找到原始的翻译文本,然后选择编辑(点击右上角「铅笔」图标),把中文内容复制到该文件中并覆盖掉原有的英文内容;然后如下图所示,在文本框下方填写提交信息(commit message)(1),在(2)和(3)中均填写翻译内容对应的中文标题即可,初次提交时请确认勾选 Commit directly to the translation_youfilename branch
(4),最后点击(5)进行提交。
这一步的目的是将自己翻译好的内容推送到主仓库,供校对人员进行后续的校对工作。
如下图所示,首先在个人项目主页新建分支下点击 New pull request (1)。
之后会看到 PR 提交页面,如下图所示:base repo (1)为官方仓库的 master 分支;head repo(2)为你个人folk项目的 translation_youfilename
新建翻译分支;接下来填写相关的 PR 信息,其中(3)处填写你所翻译内容英文文章名,在(4)处填写中文名英文名原始issue信息等内容,最后点击(5)提交 PR 即可。
对应内容的校对人员会根据 相关的校对要求,对所提交翻译内容进行校对。
校对人员完成校对后,负责人会通知译者进行修改,你可以在官方仓库对应 PR 页面看到如下的校对内容,针对校对人员的建议,你可以回复(1)他自己进行修改或者不进行修改的原因,如果你采纳了校对的建议,需要讲该处内容点击 Resolve Conversation (2) 标记为已经完成。如果不采纳则无需标记。
你可以在自己的新建翻译分支中找到自己之前翻译的文件,点击编辑按钮根据校对意见调整自己的译文,调整后和第一次 commit 相同,填写对应的 commit 消息后,选择Commit directly to the translation_youfilename branch
,最后点击进行 commit 提交。需要注意的是,此次commit 无需进行新的 PR,因为校对本质是借用的 PR 评论功能,所以无需再次 PR,系统会进行自动同步。
翻译工作至此就告一段落,等待项目负责人进行最终的调整和合并即可。
致谢:
在 Openbiox 翻译小组拟定整体翻译协作流程和实践的过程中,大量参考了 掘金翻译计划 已有的丰富经验,在此表示真挚的感谢。我们也将努力为热爱学习的生物信息学生和工作人员提供优质的中文资源。