Skip to content

Working Process

Luke Cheng edited this page Oct 2, 2019 · 7 revisions

协作流程

任务总览文档:https://shimo.im/sheets/6pmkxQY8yvJTlANr/xRsqq

项目参与总流程

  1. Fork 本项目
  2. Issue 区 认领翻译/校对
  3. 完成翻译/校对
  4. 发 Pull Request
  5. (可选)到 PR 区协助发表评论和建议

翻译任务认领

  1. 查阅 Issue 区,查看待翻译任务,可以通过任务时间和文档类型等 Label 过滤任务。
  2. 确定自己的时间和内容预期之后,留言提出要认领这个任务,并给出预计完成时间。
  3. Maintainers 一般会在 24 小时之内回复,得到回复确认之后,任务认领成功。

进行翻译

本项目所有涉及英文到中文转换的部分均称为 翻译,但不包含文档顶部的元数据,翻译要求如下:

信、达、雅

优秀的翻译贡献者会准确理解英文内容,揣摩原作者希望给读者传达的要素,然后用中文准确无误又不失优雅的表述出来。

慎用翻译 + 修改稿

请确保你所输出的每个文字都是自己理解之后斟酌写下的,我们拒绝接收从翻译工具里修改的稿件,请谅解。

文明、客观,使用书面用语

如题,也不要使用网络流行用语。

排版要求

文字排版

  • 中英文之间加入空格
  • 链接前后加入空格
  • 注意 专有名词 的翻译方法
  • 英文的里用斜体表示着重说明的部分,中文里使用加粗来标示 _英文着重_ **中文着重部分**
  • 英文里使用复数表示的内容,中文里可以使用单数
  • 英文标点是句号的,中文翻译根据语意使用逗号或者句号
  • 英文里列举内容使用逗号,中文翻译时应更换为顿号
  • (加分项) 翻译的中文与原始英文断行保持一致
  • 查看更多

Markdown 翻译排版

我们为网站加入了中英文对照以帮助更好的理解文档和发现问题,其原理是助航扫描 Markdown 的脚本,当脚本检测到英文的时候,会按照其一定格式来查看下一行是否有中文翻译,并进行双语合并。

详见:文档格式要求

我们的重点是翻译创作的结果,格式上的问题请不要吝惜你的提问,我们非常乐意回答。

翻译提交(commit 和 Pull Request)

在确认自己翻译的内容正确并自查完成后,按照 git commit 规范进行提交,提交需要注意以下事项:

  • 请确保细粒度的提交,尽可能做到一个 commit 只作用于一个文档
  • 确保 commit message 清晰明了

将相关 commit 提交至自己 Fork 的 Git 仓库后,发起 Pull Request。PR 过程中注意以下事项:

  1. 一次 PR 只能包含一个文件
  2. PR 标题格式:

[翻译完成] 路径/文件名.md(请复制完整路径名,如 dart.cn/src/docs/***.md),如:PR 标题示例

  1. PR Message 内容格式:

翻译完成 文件名.md

完成 Issue #Issue编号