Вклад в Клевер
Клевер – это, по большей части, open source и open hardware проект, который ставит своей целью уменьшение порога входа в разработку проектов, связанных с летающей робототехникой. Вы можете внести свой вклад, предлагая исправления и улучшения в документацию и ПО Клевера.
СОВЕТ
Для внесения предложений по изменению документации или ПО Клевера необходимо иметь аккаунт на GitHub.
Markdown
Вся документация Клевера написана в широко распространенном формате Markdown. В Интернете существует множество руководств по нему.
На русском: https://guides.hexlet.io/markdown/.
На английском: https://www.markdownguide.org/getting-started, https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet.
Для удобного редактирования текста, вы можете использовать текстовые редакторы с поддержкой Markdown: Typora, Dillinger (веб), VSCode с плагином Markdown Editor.
Для VSCode также рекомендуется использование плагина Code Spell Checker (словарь для русского языка).
Для локальной сборки статического сайта документации необходимо использовать утилиту gitbook-cli
.
Исправление ошибок в документации
Если вы нашли ошибку в документации или хотите ее улучшить, используйте механизм Pull Request'ов.
Найдите файл с интересующей вас статьей в репозитории – https://github.com/CopterExpress/clover/tree/master/docs.
Нажмите кнопку "Редактировать".
Внесите необходимые изменения.
Нажмите кнопку "Propose file change".
Опишите ваше изменение и нажмите кнопку "Create Pull Request".
Ожидайте принятия ваших изменений 😃
Более подробную информацию о Pull Request'ах смотрите на GitHub (англ.) или в документации по git (русск.).
Добавление статьи в GitBook
СОВЕТ
Если вы реализовали собственный интересный проект на Клевере, вы можете добавить статью о нем в раздел "Проекты на базе Клевера".
Подготовьте вашу статью и пришлите Pull Request с ней в репозиторий Клевера.
Сделайте форк репозитория Клевера:
Склонируйте форк на компьютер:
git clone https://github.com/<USERNAME>/clover.git
Перейдите в директорию с форком и создайте новую ветку с названием вашей статьи (например
new-article
):git checkout -b new-article
Напишите новую статью в разделе
docs/ru
илиdocs/en
в формате Markdown (напримерdocs/ru/new_article.md
). Не забудьте указать контактную информацию (e-mail / Telegram /...) для авторских статей.Поместите дополнительные визуальные материалы в папку
docs/assets
и оформите на них ссылки в вашей статье.Добавьте статью в файл оглавления
SUMMARY.md
в том разделе, где вы её написали (например вdocs/ru/SUMMARY.md
):... * Дополнительные материалы * [Олимпиада НТИ 2019](nti2019.md) * [Вклад в Клевер](contributing.md) * [Новая статья](new_article.md) * [Сборка и модификация образа Клевера](image_building.md) * [Прошивка ESC контроллеров](esc_firmware.md) ...
Сохраните состояние ваших изменений локально:
git add docs/ git commit -m "Add new article for Clover"
Загрузите вашу новую ветку с изменениями на ваш GitHub репозиторий с форком Клевера:
git push -u origin new-article
Перейдите на web страницу вашего форка и сделайте
pull request
вашей ветки в master Клевера:Дождитесь комментариев на свою статью, сделайте правки, если потребуется.
Порадуйтесь своей новой полезной статье, опубликованной на https://clover.coex.tech !
Простой способ
Если вышеприведенные инструкции для вас оказываются слишком сложными, отправляйте правки или новые статьи по e-mail (okalachev@gmail.com) или в Telegram (пользователь @okalachev).
Публикация пакетов
Вы также можете опубликовать собственный пакет, расширяющий функциональность Клевера, в Debian-репозитории COEX.