Awesome

翻译规范

　　本项目是针对Gradle官方docs的翻译项目，旨在为Gradle中文化贡献绵薄微力 　　 　如果您想参与进来，请仔细阅读以下内容。

　　为了提高翻译质量和协同效率，特约定些文档。在参与翻译前，请仔细阅读此文档。

• 中文技术文档协作规范

• 成员名单

• 在线阅读

质量保证

• 使用互相 Review 机制，修改后发 Pull Request（小修改除外），Collaborator 看到后，如果有问题回复指出；如果没有问题，简单回复一下并 Accept 即可；

• 为保证同步性,每个子版本需要结合release note对领取的章节进行一次校对。

• 采用领取停滞取代原则，任务领取后若长期停滞（超过30天）则领取的目标任务回归到无人领取状态。

• 对于历史版本，将会以tag的形式留存下来。

加入翻译

如果想贡献一份力量请加入QQ群:466275646

欢迎加入我们一起为 Gradle 在中文推广出一份力，对于有能力且积极的同学会被邀请加入我们 Group。

开始翻译前，你可以通过以下方式认领，确保没有重复工作。

如何开始

• 领取

按章节领取，对于未被翻译的章节，应在翻译前进行翻译认领来保证没有人和你做重复工作。很简单，请从 repo 的 issue 列表中认领，如果没有对应章节的 issue，自己创建一个即可。

• 翻译

认领成功后就代表你已经成功占到一个坑，你可以开始慢慢翻译自己的文章了。为了保证理解的准确性和阅读的方便性，翻译时采用保留原文的方式，以段落为单元，译文在上原文在下 如果占坑太久你的占位可能被取消，尽量在30天内完成。

• 校对

对于已经翻译的章节，欢迎做校验工作，校验不需要认领，fork 后修改并发 Pull Request 即可。校对的内容不限于语言表达的准确性、标点以及排版格式等。

协作规范

• 成为 Collaborator 说明自己的能力和贡献被肯定，是很光荣的事情。有直接操作代码库和 Accept 别人 Pull Request 的权限，为了避免错误的操作，因此需要一些规范来约束自己。

• Collaborator 应该是活跃的，遇到 Pull Request 主动 Review，主动参与和发起讨论。

• 自己发的 Pull Request 虽有合并权限，但需要至少其它一人 Reivew 后才能合并

翻译流程

一、fork 要翻译的 repo

二、如果是新翻译章节，应参照对应的原文进行翻译；如果是校对则直接修改 可以使用 OmegaT \ sublime 等提高翻译效率，为增强可读性，建议翻译之前先用你所用编辑器的插件对html源码进行格式化。

三、由于官方文档目录结构较为凌乱，为了便于维护和查找，翻译时需要建立对应章节文件夹，并以chn的形式进行命名，将对应章节文件移动到目标文件夹中。

四、翻译结束，提交 Pull Request

五、fork 后的 repo 如何同步本 repo？

// 添加 upstream 源，只需执行一次
git remote add upstream git@github.com:gradlecn/gradledoc.git
// 拉取远程代码
git pull upstream master
// 更新 fork 仓库
git push origin master

更多参考：https://help.github.com/articles/syncing-a-fork/

翻译约定

• 阿拉伯数字不进行翻译，翻译时大小章节号不进行重复描述，大章节号只保留中文描述；
• 小贴士(tips/notes)内容采用 > 引用的样式出现;
• 不译的英文名词复数改为单数，因为中文没有复数的概念；
• 专有名词保持大写：HTML, HAML, SASS, REST... 等等；
• 英文和数字与中文之间要留空格。中文标点符号和中文之间不需要留空格；
• 使用中文的标点符号。句号是 。 不是 .，破折号是 —— 不是 -；
• 英文有斜体、中文没有，可用强调取代 **强调**；
• 译文和原文行数应保持一致，以便于后期同步更新；
• 代码缩进使用两个空格，禁止使用 Tab；
• 按照语义把英文逗号改为中文顿号；
• 译完自己读一次，看看像不像中文；
• 遇到不确定的翻译很正常，请在 Pull Request 里指出，大家一起解决。

名词约定

为了免除误解，这些词第一次出现时可以用 （） 来显示原文。

保留名词

专有名词，在不造成读者理解困难的情况下，尽量保持原汁原味。

建议与反馈

欢迎任何建议！直接开一个 github issues 就可以了。

License

本文档的副本可以免费分发阅读，请勿用作商业用途。

交流群:109752483

翻译群:466275646

娱乐群:576648359