contribute.md · DiDi-opensource/ChineseNLP

# 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`.

* First click the `edit` button on the top right corner.

![click the edit button](img/edit.png)

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

![Make changes](img/fork.png)

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

![Commit your change](img/commit.png)

## Fork and pull request

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

* Fork this repo.
* 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](http://localhost:8000)

* Adding a new file `docs/new_task.md`.
  * The new file should follow [docs/template.md](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`.

## Useful Tools
* [Docute](https://docute.org/)
* [Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
* [Google Sheet Table to Markdown Converter](https://chrome.google.com/webstore/detail/markdowntablemaker/cofkbgfmijanlcdooemafafokhhaeold?hl=en)

DiDi-opensource/ChineseNLP

简介

发行版

贡献者

近期动态

DiDi-opensource/ChineseNLP .gitee-modal { width: 500px !important; }

简介

发行版

开源评估指数源自 OSS-Compass 评估体系，评估体系围绕以下三个维度对项目展开评估：

贡献者

近期动态

搜索帮助

DiDi-opensource/ChineseNLP