Skip to content

Commit e24d7bf

Browse files
committed
Add CONTRIBUTING.md
address #40
1 parent c044daa commit e24d7bf

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

CONTRIBUTING.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
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 easy 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 Git workflow and the reStructureText.
14+
A PR is needed to be reviewed by at aleast one person before merging.
15+
16+
## Document format
17+
18+
* Chinese writing guideline
19+
20+
Follow section 3 in https://mirrors.ustc.edu.cn/anthon/aosc-l10n/zh_CN_l10n.pdf
21+
22+
* reStructureText syntax
23+
24+
Make sure `sphinx-build` run without warnings.
25+
26+
## Credit
27+
28+
For those improved the documnets, the Github username will be mentioned in the document.

0 commit comments

Comments
 (0)