docs: rename contribution.md to contributing.md

This commit is contained in:
Andrei Korigodski
2018-11-22 19:48:27 +03:00
parent 30a6ee9528
commit e20d2f4076
2 changed files with 1 additions and 1 deletions

39
docs/contributing.md Normal file
View File

@@ -0,0 +1,39 @@
# Вклад в Клевер
Клевер это, по большей части, [open source](https://ru.wikipedia.org/wiki/Открытое_программное_обеспечение) и [open hardware](https://ru.wikipedia.org/wiki/Открытое_аппаратное_обеспечение) проект, который ставит своей целью уменьшение порога входа в разработку проектов, связанных с летающей робототехникой. Вы можете внести свой вклад, предлагая исправления и улучшения в документацию и ПО Клевера.
> **Note** Для внесения предложений по изменению документации или ПО Клевера необходимо иметь аккаунт на [GitHub](https://github.com).
## Markdown
Вся документация Клевера написана в широко распространенном формате [Markdown](https://ru.wikipedia.org/wiki/Markdown). В Интернете существует множество руководств по нему.
На русском: https://guides.hexlet.io/markdown/.
На английском: https://www.markdownguide.org/getting-started, https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet.
## Исправление ошибок в документации
Если вы нашли ошибку в документации или хотите ее улучшить, используйте механизм Pull Request'ов.
1. Найдите файл с интересующей вас статьей в репозитории  https://github.com/CopterExpress/clever/tree/master/docs.
2. Нажмите кнопку "Редактировать".
<img src="assets/github-edit.png" alt="GitHub Edit">
3. Внесите необходимые изменения.
4. Нажмите кнопку "Propose file change".
5. Опишите ваше изменение и нажмите кнопку "Create Pull Request".
6. Ожидайте принятия ваших изменений :)
Более подробную информацию о Pull Request'ах смотрите [на GitHub](https://help.github.com/articles/about-pull-requests/) (англ.) или в [документации по git](https://git-scm.com/book/ru/v2/GitHub-Внесение-собственного-вклада-в-проекты) (русск.).
## Добавление новой статьи
TODO
## Ваш проект с Клевером
Если вы реализовали собственный интересный проект на Клевереве, вы можете добавить статью о нем в раздел "Проекты".
TODO