realywithoutname / ecma262

Status, process, and documents for ECMA262

ECMAScript 中文

关于该仓库

该仓库包含ECMAScript®语言规范当前草案(包含stage 2 - stage 4)的中文翻译，你可以在一下网站进行浏览。

• 英文
• 中文

贡献

加入我们

微信：17764592171

约定

• LN 表示文档行号
• issues 表示github的issues菜单
• pull request 表示github的pull request功能

角色

• 项目维护者 负责对翻译分支，校对分支，cn分支的管理。
• 校对者 负责指出新翻译内容中错译、漏译、标点符号错误、错别字、大小写、拼写错误、单复数、动词时态、数字错误等错误
• 翻译参与者 从issues中选择自己希望翻译的内容在本地进行翻译，具体翻译流程可查看翻译流程
• 审校者 负责对翻译内容的语句润色，通顺，专业性等工作

分支管理

• translated 翻译分支。对于该分支下被合并的内容将永远存在，除非被新内容覆盖。
• checking 审校分支。
• cn 发布分支。使用工具进行自动部署

翻译流程

• 翻译参与者fork此仓库到个人仓库，在本地检出translated分支。
  • 在issues列表中选择label为待翻译的issue，确认认领翻译任务并通知(@)项维护者者(修改label为翻译中)
  • 翻译参与者请在translated文件夹的issues-[ISSUE ID].html文件中进行对原文进行翻译。（为了方便校对时使用github进行校对）
  • 翻译完成后
    • 使用issues-[ISSUE ID]替换spec.html文件中相应的英文原文，并保证npm run build顺利通过，并检查内容与期待结果一样
    • 丢弃spec.html文件更改内容
    • 提交翻译内容（最好是多个提交先在本地合并为一个提交），建议commit message为translated：[LN - LN] issue #ISSUE ID(为了审校时方便替换)
• 翻译参与者将翻译内容推送到自己的公开仓库。
• 翻译参与者使用github的pull request通知维护者，请求拉取自己的更新。
• 翻译参与者应该关注相应issue，校对者会在此issue提交review意见，直到提交被合并，对于长时间（距离issue中最后的评论时间超过三天）未被接受的pull request如果在相应issue中没有找到拒绝理由，可以直接联系维护者问名原因。

合并流程

• 接受pull request 项维护者者

  • 在本地对新的pull request进行如下处理
    • 项目维护者从翻译参与者提交的pull request中合并翻译内容，并保证可以成功build，且内容格式与原文无误
      • 通过，在对应的issue添加lable——待校对，附上校对地址
      • 失败，在对应的pull request评论拒绝原因

• 校对 任何人

  • 任何人可对label为待校对的issue对应的pull request进行review，并作出意见（参考掘金的参与校对的正确姿势）
  • 如果有修改意见，翻译者应在原分支上进行修改(不需重新pull request)，并在对应issue通知（@）校对者和项维护者者修改完成
  • 项维护者者检查issue状态
    • 所有review意见修改完成或没有意见且距离pull request时间超过三天，接受合并，修改对应issue的label为待审校

• 审校 审校负责人

  • 可能邀请大神对翻译内容进行审校，这将是本次提交的最后检查，提交内容可能在该阶段进行一些专业性的修改，和语句上的润色
  • 由通过对比translated与checking分支，每次从translated分支cherry-pick第一个不同的提交版本进行合并
  • 使用需审校提交的译文替换spec.html中对应的部分。
  • 提交checking分支，审校团队进行讨论修改，确认无误表示完成审校流程。
  • 完成审校后通知项维护者者或者审校负责人进行合并到cn分支
  • 修改对应issue的label为已发布
  • 提交审校完成，进入下一轮审校流程

• 发布

  • 使用工具在每次checking分支的修改后对该分支进行部署
  • 使用工具在每次cn分支的修改后对该分支进行部署

  两个分支在不同的域查看

• 追踪tc39 项维护者者

  • 在master分支跟踪tc39/master分支
  • 使用diff检出修改内容
  • 构建任务
  • 重复整个流程

可能具体合并流程还会修改，但是对于翻译阶段不受影响