# 贡献指南

为了使项目更加便于维护，我们将文档格式全部转换成了 Markdown，同时更换了页面生成器。后续维护工作将完全在 Markdown 上进行。

小部分格式仍然存在问题，主要是链接和表格。需要大家帮忙找到，并提 PullRequest 来修复。

## 参与翻译 & 发现错误

1. 在 github 上 fork 该 repository。
2. 翻译 doc/zh 下面的 md 文件即可，例如，index.md。
3. 然后，在你的 github 发起 New pull request 请求。
4. 工具使用，可参考下面的内容。

## 工具使用（针对新手）

工欲善其事，必先利其器 ...  
工具随意，能达到效果就好。  
我这里使用的是 `VSCode` 编辑器。  
简易的使用指南请参阅：[VSCode Windows 平台入门使用指南](help/vscode-windows-usage.md)，介绍了 `VSCode` 与 `github` 一起搭配的简易使用的方法。  
如果要将 VSCode 的 Markdown 预览风格切换为 github 的风格，请参阅：[VSCode 修改 markdown 的预览风格为 github 的风格](help/vscode-markdown-preview-github-style.md)。

## 角色分配

目前有如下可分配的角色：

* 翻译：负责文章内容的翻译。
* 校验：负责文章内容的校验，比如格式，正确度之类的。
* 负责人：负责整个 Projcet，不至于让该 Project 成为垃圾项目，需要在 Spark 方面经验稍微丰富点。

有兴趣参与的朋友，可以看看最后的联系方式。