-
Notifications
You must be signed in to change notification settings - Fork 146
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
address #40
- Loading branch information
Showing
1 changed file
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# How to contribute | ||
|
||
## Ways to improve the documents | ||
|
||
* Submit a issue | ||
|
||
If you find errors in documents or want to improve, this is the easiest way to help. | ||
You can put your document in any format in the issue comments, then a core developer | ||
will format it with reStructureText syntax and commit it into the repo. | ||
|
||
* Send a pull request | ||
|
||
This way is for those who are familar with | ||
[Git workflow](https://guides.github.com/introduction/flow/) and the | ||
[reStructureText](http://www.sphinx-doc.org/en/stable/rest.html). | ||
A PR is needed to be reviewed by at least one person before merging. | ||
|
||
## Document format | ||
|
||
* Chinese writing guideline | ||
|
||
Follow section 3 in https://mirrors.ustc.edu.cn/anthon/aosc-l10n/zh_CN_l10n.pdf | ||
|
||
* reStructureText syntax | ||
|
||
Make sure `sphinx-build` run without warnings. | ||
|
||
## Credit | ||
|
||
For those improved the documnets, the Github username will be mentioned in the document. |