spec translation

翻译须知

首先，我们在 github 开展翻译的相关工作。翻译的内容来自 [W3C Github] 的项目。翻译的产出会放在 W3C HTML 中文兴趣组 Github。

附带一个中文的git教材

小组之前是在 ig/zh/wiki 上开展工作的，大家可以查阅小组之前已有的翻译内容

翻译流程简介

• 【确定翻译内容】建议以一份规范为颗粒度，特殊的项目可以特殊考虑，比如：
  • 将多份规范合并成一组规范，或
  • 把一份大的规范拆分成多份小规范
• 【创建项目】在 W3C HTML 中文兴趣组 Github 为这份/组规范创建一个项目
  • 名字尽量和来源项目的名字匹配
  • 直接把 gh-pages 设置为主分支，已便将来直接发布为 github.io 的网页
• 【初始化文件结构】把最新的静态文件直接复制到新创建的项目
  • 简单写一份 README.md 并标识出原规范对应的最新提交(commit hash)
• 【翻译与校对】翻译文档并及时提交
  • 翻译告一段路之后进行校对
• 【打标发布】翻译完成之后打一个 tag 并发布 (tag 小贴士)
• 【及时同步官方改动】保持关注官方版本的变化，并在合适的时机把改动同步到翻译中
  • 通过 github compare 确定改动范围 (github compare 小贴士)
  • 重复“初始化文件结构”->“打标发布”->“及时同步官方改动”

个人参与某规范翻译的注意事项

• 找到要翻译的项目，找到(或创建新的)中文兴趣组对应的项目
• 为了避免冲突，请务必在翻译之前，在相应项目的 issues 里创建一个 issue，说明你翻译的范围和 commit hash。
• fork 项目到自己的 github
• 在自己的项目完成编辑
  • checkout 到一个新的分支
  • 更新 README.md 中的 commit hash 说明【重要】
  • 本地翻译 + commit
  • push 到线上
• 从自己的项目向中文兴趣组的项目发起“pull request”，并接受大家的校对
  • 联系小组的其他人校对你的翻译成果
  • 也欢迎大家通过小组的邮件组征集校对者
  • 校对可能会被接受、拒绝或被建议继续改进，继续改进可以通过继续在自己的分支上 commit + push
• 翻译结束，可以删除自己的项目中对应的分支，建议每再翻译的时候重新建立一个分支并起不一样的分支名