Skip to content

Home

Jump to bottom
cypress-zh edited this page May 17, 2019 · 9 revisions

Welcome to the cypress-documentation wiki!

翻译指南

  1. 首先你需要下载安装好git客户端和Node.js， 还需要一个github账号，操作系统推荐使用Mac，win10正版或其他类Linux/Unix系统(盗版win10或win7可能会报系统构建错误，据已经了解到的信息目前无解)；

  2. 找绿豆酱将你的账号发给他，好让他添加你到cypress-documentation的开发组；

  3. git clone https://github.com/icelemon1314/cypress-documentation.git；

  4. 进入到cypress-documentation的根目录，执行npm i进行安装, 如果没出错，继续执行npm run build, 如果build没出错，继续npm start，此时你应该会看到npm的本地server起来了(有时候半天没反应需要自己敲一下回车)，可以访问http://localhost:2222/;

  5. 用VSCode打开cypress-documentation的根目录，逐级找到zh-cn这个子目录，这个目录下面的文档就是中文对应的资源文件，选中一个你想翻译的文档，对比这个腾讯在线共享文档的另外翻译清单，如果没人认领你就可以更新自己的认领到腾讯共享文档里并开始翻译了；

  6. 正式开始前，你需要建立一个本地分支(例如你的名字叫jack, 那么你可以这样: git branch translation-zh-cn-jack)，并建立与远程仓库(github)的连接对应关系(先git push origin translation-zh-cn-jack， 然后git branch --set-upstream-to=origin/translation-zh-cn-jack)，翻译完成后，用git add 你翻译好的文件，再git commit添加描述(如"xxx.md translation for chinese comleted.")， 最后git push把修改推到自己的远程分支，push完成后提pull request：base库和分支选择icelemon1314 -> cypress-documentaion下的translation-zh-cn， compare选择自己创建和push的分支，确认是自己的修改的文案后确定发起PR即可(绿豆酱会不定时做merge，最后形成一份总和所有人翻译的中文翻译)；

  7. 感谢付出，你的职业生涯对开源软件做出了贡献，作为奖励，我和绿豆酱将会申请将你的昵称添加到之后cypress release发布的感谢感言里。再次感谢！

翻译规范

  1. 标点 除为了生成文档引述、链接等必须使用英文符号外，其他统一采用中文标点
  2. 序号 当存在多级目录时，用"数字"+"."+"空格"作为前缀，如原文中的# 标题层级1、## 标题层级2对应翻译为1. 标题层级1、1.1 标题层级2
  3. 链接 为了避免多人翻译的异样，英文的链接部分，可以暂时原样不动，等最终校对时统一命名，如{% url 'debug' https://github.com/visionmedia/debug %}中的第一个debug等
  4. 注释 原文中的注释，最好不要保持原样，尽量也一起翻译过来，如代码中的双斜杠注释等。

Clone this wiki locally