贡献指南

分支作用简介

• master：作为中文文档的主干，所有翻译的工作都在本分支完成
• tracking-source：只用来同步官方文档所有的更新
• gh-pages：中文文档站的静态资源分支，本分支不会手动更新，全部由master分支生成

与官方文档同步机制

• 前期在翻译工作未全面展开的情况下，采用合并官方文档仓库的方式保持同步，以减少工作量
• 后期在翻译工作基本完成的情况下，采用手动提交并翻译 diff 的方式保持同步

中文文档需要翻译的部分

• 文档部分：doc 目录下的所有 markdown 文件(.md)
• 操作符 API 部分：src 目录下的源代码(.ts)
  • src/observable 目录下的是静态操作符
  • src/operator 目录下的是实例操作符
• 操作符选择决策树插件：doc/decision-tree-widget 目录下的 src/main.js 和 tree.yml

协作方式

初期由于是个人参与，所以采取了直接 push 的简单方式。 目前由于是多人协作，建议采用 Github Flow：fork -> pull request -> review -> merge 。