|
| 1 | +# How to contribute |
| 2 | + |
| 3 | +## Ways to improve the documents |
| 4 | + |
| 5 | +* Submit a issue |
| 6 | + |
| 7 | + If you find errors in documents or want to improve, this is the easiest way to help. |
| 8 | + You can put your document in any format in the issue comments, then a core developer |
| 9 | + will format it with reStructureText syntax and commit it into the repo. |
| 10 | + |
| 11 | +* Send a pull request |
| 12 | + |
| 13 | + This way is for those who are familar with |
| 14 | + [Git workflow](https://guides.github.com/introduction/flow/) and the |
| 15 | + [reStructureText](http://www.sphinx-doc.org/en/stable/rest.html). |
| 16 | + A PR needs to be reviewed by at least one person before merging. |
| 17 | + |
| 18 | +## Document format |
| 19 | + |
| 20 | +* Chinese writing guideline |
| 21 | + |
| 22 | + Follow section 3 in https://mirrors.ustc.edu.cn/anthon/aosc-l10n/zh_CN_l10n.pdf |
| 23 | + |
| 24 | +* reStructureText syntax |
| 25 | + |
| 26 | + Make sure `make html` run without errors. |
| 27 | + |
| 28 | + Please include a single rst file in a [TOC tree](http://www.sphinx-doc.org/en/stable/markup/toctree.html). |
| 29 | + For example, add a reference in `index.rst`. |
| 30 | + |
| 31 | +## Credit |
| 32 | + |
| 33 | +For those improved the documnets, the Github username will be mentioned in the document. |
| 34 | + |
| 35 | + |
| 36 | +# 如何贡献 |
| 37 | + |
| 38 | +## 如何改善文档 |
| 39 | + |
| 40 | +* 提交 issue |
| 41 | + |
| 42 | + 如果你发现文档中有错误,你可以在 issue 中提出。你也可以在 issue 中提交改进后的文档。 |
| 43 | + Issue 中提交的文档可以用任何格式撰写,后面我们会把文档格式化成标准的 reStructureText 格式。 |
| 44 | + |
| 45 | +* 提交 pull request |
| 46 | + |
| 47 | + 如果你熟悉 [Git 的协作流程](https://guides.github.com/introduction/flow/), |
| 48 | + 也熟悉 [reStructureText 格式](http://www.sphinx-doc.org/en/stable/rest.html), |
| 49 | + 请 pull request。 |
| 50 | + 注意 PR 在合并前至少需要一个人进行 review。 |
| 51 | + |
| 52 | +## 文档格式 |
| 53 | + |
| 54 | +* 中文写作规范 |
| 55 | + |
| 56 | + 请参考 https://mirrors.ustc.edu.cn/anthon/aosc-l10n/zh_CN_l10n.pdf 中的第 3 章节。 |
| 57 | + |
| 58 | +* reStructureText 格式 |
| 59 | + |
| 60 | + `make html` 会检查语法,请确保运行结果没有错误。 |
| 61 | + |
| 62 | + 单个 rst 文件需要被包含在 [TOC tree](http://www.sphinx-doc.org/en/stable/markup/toctree.html) 中,例如可以在 `index.rst` 文件中添加索引。 |
| 63 | + |
| 64 | +## 署名 |
| 65 | + |
| 66 | +参与任何形式的贡献,相关的 Github 用户名会在文档中提交。 |
0 commit comments