Вклад в Клевер

Клевер – это, по большей части, open sourceopen in new window и open hardwareopen in new window проект, который ставит своей целью уменьшение порога входа в разработку проектов, связанных с летающей робототехникой. Вы можете внести свой вклад, предлагая исправления и улучшения в документацию и ПО Клевера.

СОВЕТ

Для внесения предложений по изменению документации или ПО Клевера необходимо иметь аккаунт на GitHubopen in new window.

Markdown

Вся документация Клевера написана в широко распространенном формате Markdownopen in new window. В Интернете существует множество руководств по нему.

На русском: https://guides.hexlet.io/markdown/open in new window.

На английском: https://www.markdownguide.org/getting-startedopen in new window, https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheetopen in new window.

Для удобного редактирования текста, вы можете использовать текстовые редакторы с поддержкой Markdown: Typoraopen in new window, Dillingeropen in new window (веб), VSCodeopen in new window с плагином Markdown Editoropen in new window.

Для VSCode также рекомендуется использование плагина Code Spell Checkeropen in new window (словарь для русского языкаopen in new window).

Для локальной сборки статического сайта документации необходимо использовать утилиту gitbook-cliopen in new window.

Исправление ошибок в документации

Если вы нашли ошибку в документации или хотите ее улучшить, используйте механизм Pull Request'ов.

  1. Найдите файл с интересующей вас статьей в репозитории – https://github.com/CopterExpress/clover/tree/master/docsopen in new window.

  2. Нажмите кнопку "Редактировать".

    GitHub Edit
  3. Внесите необходимые изменения.

  4. Нажмите кнопку "Propose file change".

  5. Опишите ваше изменение и нажмите кнопку "Create Pull Request".

  6. Ожидайте принятия ваших изменений 😃

Более подробную информацию о Pull Request'ах смотрите на GitHubopen in new window (англ.) или в документации по gitopen in new window (русск.).

Добавление статьи в GitBook

СОВЕТ

Если вы реализовали собственный интересный проект на Клевере, вы можете добавить статью о нем в раздел "Проекты на базе Клевера".

Подготовьте вашу статью и пришлите Pull Request с ней в репозиторий Клевераopen in new window.

  1. Сделайте форк репозитория Клевера:

    GitHub Fork
  2. Склонируйте форк на компьютер:

    git clone https://github.com/<USERNAME>/clover.git
    
  3. Перейдите в директорию с форком и создайте новую ветку с названием вашей статьи (например new-article):

    git checkout -b new-article
    
  4. Напишите новую статью в разделе docs/ru или docs/en в формате Markdownopen in new window (например docs/ru/new_article.md). Не забудьте указать контактную информацию (e-mail / Telegram /...) для авторских статей.

  5. Поместите дополнительные визуальные материалы в папку docs/assets и оформите на них ссылки в вашей статье.

  6. Добавьте статью в файл оглавления SUMMARY.md в том разделе, где вы её написали (например в docs/ru/SUMMARY.md):

    ...
    * Дополнительные материалы
      * [Олимпиада НТИ 2019](nti2019.md)
      * [Вклад в Клевер](contributing.md)
      * [Новая статья](new_article.md)
      * [Сборка и модификация образа Клевера](image_building.md)
      * [Прошивка ESC контроллеров](esc_firmware.md)
    ...
    
  7. Сохраните состояние ваших изменений локально:

    git add docs/
    git commit -m "Add new article for Clover"
    
  8. Загрузите вашу новую ветку с изменениями на ваш GitHub репозиторий с форком Клевера:

    git push -u origin new-article
    
  9. Перейдите на web страницу вашего форка и сделайте pull request вашей ветки в master Клевера:

    GitHub Pull RequestGitHub Create Pull
  10. Дождитесь комментариев на свою статью, сделайте правки, если потребуется.

  11. Порадуйтесь своей новой полезной статье, опубликованной на https://clover.coex.techopen in new window !

Простой способ

Если вышеприведенные инструкции для вас оказываются слишком сложными, отправляйте правки или новые статьи по e-mail (okalachev@gmail.com) или в Telegram (пользователь @okalachev).

Публикация пакетов

Вы также можете опубликовать собственный пакет, расширяющий функциональность Клевера, в Debian-репозитории COEX.