docs: contribution

This commit is contained in:
Oleg Kalachev
2018-11-21 22:01:02 +03:00
parent 37443c9fdc
commit 3de413cf71
3 changed files with 42 additions and 0 deletions

View File

@@ -52,6 +52,7 @@
* [Прошивка ESC контроллеров с помощью Arduino](esc_firmware.md)
* [Работа со светодиодной лентой](leds.md)
* Другое
* [Вклад в Клевер](contribution.md)
* [CopterHack-2018](copterhack2018.md)
* [CopterHack-2017](copterhack2017.md)
* [Проекты на базе коптера "Клевер"](projects.md)

BIN
docs/assets/github-edit.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 170 KiB

41
docs/contribution.md Normal file
View File

@@ -0,0 +1,41 @@
# Контрибуция
Клевер это, по большей части, [open source](https://ru.wikipedia.org/wiki/Открытое_программное_обеспечение) и [open hardware](https://ru.wikipedia.org/wiki/Открытое_аппаратное_обеспечение) проект, который ставит своей целью уменьшить порог входа в обучение и программирование дронов и создание мощного сообщества людей, увлекающихся летающей робототехникой. Вы можете внести свой вклад в этот проект, предлогая исправления и улучшения в документацию и ПО Клевера.
Ежедневно несколько сотен человек используют их для изучения квадрокоптеров и реализации своих проектов.
## 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.
> **Note** Для внесения предложений по изменению документации или ПО Клевера необходимо иметь аккаунт на [GitHub](https://github.com).
## Исправление ошибок в документации
Если вы нашли ошибку в документации или хотите ее улучить, используйте механизм Pull Request'ов.
* Найдите файл интересующей вас статьи в репозитории  https://github.com/CopterExpress/clever/tree/master/docs,
* Нажмите кнопку "редактировать".
<img src="assets/github-edit.png" alt="GitHub Edit">
* Внесите необходимые изменения.
* Нажмите кнопку "Propose file change".
* Опишите ваше изменение и нажмите кнопку "Create Pull Request".
* Ожидайте принятия ваших изменений :)
Более подробную информацию о Pull Request'ах смотрите [на GitHub](https://help.github.com/articles/about-pull-requests/) (англ.) или в [документации по git](https://git-scm.com/book/ru/v2/GitHub-Внесение-собственного-вклада-в-проекты) (русск.).
## Добавление новой статьи
TODO
## Ваш проект с Клевером
Если вы реализовали собственный интересный проект на Клевереве, вы можете добавить статью о нем в раздел "Проекты".
TODO