From 7d94b11479f9650845e7a84733c12ebdecc922ec Mon Sep 17 00:00:00 2001 From: zhsj Date: Sat, 25 Mar 2017 01:44:46 +0800 Subject: [PATCH] Add CONTRIBUTING.md address #40 --- CONTRIBUTING.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..dbaa462f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,28 @@ +# How to contribute + +## Ways to improve the documents + +* Submit a issue + + If you find errors in documents or want to improve, this is the easy 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 and the reStructureText. + A PR is needed to be reviewed by at aleast one person before merging. + +## Document format + +* Chinese writing guideline + + Follow section 3 in http://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.