Skip to content

Commit

Permalink
Add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
address #40
  • Loading branch information
zhsj authored Mar 24, 2017
1 parent 9d2d60b commit 7d94b11
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 7d94b11

Please sign in to comment.