Как внести свой вклад

Есть два способа внести свой вклад:

• Редактирование на месте в Github. Подходит для небольших изменений в существующих файлах Markdown.
• Форк и запрос на включение. Подходит для больших изменений, например, добавления новой задачи.

Редактирование на месте в Github

Предположим, вы хотите изменить файл docs/word_segmentation.md.

• Сначала нажмите кнопку «Редактировать» в правом верхнем углу.

  

• Github автоматически создаст форк репозитория, как подсказывает система. Вы можете внести изменения в редакторе Markdown от Github.

  

• После завершения редактирования убедитесь, что вы просмотрели изменения. Пожалуйста, пишите осмысленные сообщения о фиксации и нажимайте «Предложить изменение файла».

  

Форк и запрос на включение

Предположим, вы хотите добавить новую страницу docs/new_task.md

• Сделайте форк этого репозитория.
• Клонируйте свой форкнутый репозиторий на локальный компьютер.

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

• Запустите этот веб-сайт.

Если вы используете Python 3:

cd ChineseNLP
python3 -m http.server

Если вы используете Python 2:

cd ChineseNLP
python -m SimpleHTTPServer

Просмотрите веб-сайт по адресу http://localhost:8000.

• Добавьте новый файл docs/new_task.md. Новый файл должен соответствовать шаблону docs/template.md. Добавьте ссылку в раздел sidebar в index.html.
• Зафиксируйте и отправьте изменения в свой форкнутый репозиторий.
• Создайте запрос на включение в chinesenlpxyz/ChineseNLP:master.

Полезные инструменты

• Docute
• Markdown Cheatsheet
• Google Sheet Table to Markdown Converter