How to contribute

There are two ways to contribute:

Edit in Github inplace. It's suitable for small changes on existing markdown files.
Fork and pull request. It's suitable for big changes, e.g. adding a new task.

Edit in Github inplace

Suppose you want to change docs/word_segmentation.md.

Github will automatically fork the repo as the prompts, you can make changes in github's markdown editor.

Once you finish editing, make sure you preview the changes. Please write meaningful commit messages and click Propose file change.

Suppose you want to add a new page as docs/new_task.md

Clone your forked repo to your local machine

git clone https://github.com/YOUR_GITHUB_NAME/ChineseNLP.git

Serve this website
```
cd ChineseNLP
python3 -m http.server
```
if you are using python 2
```
cd ChineseNLP
python -m SimpleHTTPServer
```
- View the website at http://localhost:8000
Adding a new file docs/new_task.md.
- The new file should follow docs/template.md
- Add a link in section sidebar in index.html.
Commit and push to your forked repo.
Create a pull request to chinesenlpxyz/ChineseNLP:master.