File tree 1 file changed +30
-0
lines changed
1 file changed +30
-0
lines changed Original file line number Diff line number Diff line change
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 is needed 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 ` sphinx-build ` run without warnings.
27
+
28
+ ## Credit
29
+
30
+ For those improved the documnets, the Github username will be mentioned in the document.
You can’t perform that action at this time.
0 commit comments