diff --git a/docs/assets/github-fork.png b/docs/assets/github-fork.png new file mode 100644 index 00000000..d0a7a604 Binary files /dev/null and b/docs/assets/github-fork.png differ diff --git a/docs/assets/github-pull-request-create.png b/docs/assets/github-pull-request-create.png new file mode 100644 index 00000000..7ba72c48 Binary files /dev/null and b/docs/assets/github-pull-request-create.png differ diff --git a/docs/assets/github-pull-request.png b/docs/assets/github-pull-request.png new file mode 100644 index 00000000..ebd67cb9 Binary files /dev/null and b/docs/assets/github-pull-request.png differ diff --git a/docs/ru/contributing.md b/docs/ru/contributing.md index db2ebce0..55a278ea 100644 --- a/docs/ru/contributing.md +++ b/docs/ru/contributing.md @@ -34,10 +34,61 @@ Более подробную информацию о Pull Request'ах смотрите [на GitHub](https://help.github.com/articles/about-pull-requests/) (англ.) или в [документации по git](https://git-scm.com/book/ru/v2/GitHub-Внесение-собственного-вклада-в-проекты) (русск.). -## Ваш проект с Клевером +## Добавление статьи в GitBook -Если вы реализовали собственный интересный проект на Клевере, вы можете добавить статью о нем в раздел "Проекты на базе Клевера". +> **Note** Если вы реализовали собственный интересный проект на Клевере, вы можете добавить статью о нем в раздел "Проекты на базе Клевера". Подготовьте вашу статью и пришлите Pull Request с ней в [репозиторий Клевера](https://github.com/CopterExpress/clever). - +1. Сделайте форк репозитория Клевера: + + GitHub Fork + +2. Склонируйте форк на компьютер: + + ```bash + git clone https://github.com//clever.git + ``` + +3. Перейдите в директорию с форком и создайте новую ветку с названием вашей статьи (например `new-article`): + + ```bash + git checkout -b new-article + ``` + +4. Напишите новую статью в разделе `docs/ru` или `docs/en` в формате [Markdown](https://ru.wikipedia.org/wiki/Markdown) (например `docs/ru/new_article.md`). +5. Поместите дополнительные визуальные материалы в папку `docs/assets` и оформите на них ссылки в вашей статье. +6. Добавьте статью в файл оглавления `SUMMARY.md` в том разделе, где вы её написали (например в `docs/ru/SUMMARY.md`): + + ```bash + ... + * Дополнительные материалы + * [Олимпиада НТИ 2019](nti2019.md) + * [Вклад в Клевер](contributing.md) + * [Новая статья](new_article.md) + * [Сборка и модификация образа Клевера](image_building.md) + * [Прошивка ESC контроллеров](esc_firmware.md) + ... + ``` + +7. Сохраните состояние ваших изменений локально: + + ```bash + git add docs/ + git commit -m "Add new article for Clever" + ``` + +8. Загрузите вашу новую ветку с изменениями на ваш GitHub репозиторий с форком Клевера: + + ```bash + git push -u origin new-article + ``` + +9. Перейдите на web страницу вашего форка и сделайте `pull request` вашей ветки в master Клевера: + + GitHub Pull Request + + GitHub Create Pull + +10. Дождитесь комментариев на свою статью, сделайте правки, если потребуется. +11. Порадуйтесь своей новой полезной статье, опубликованной на https://clever.copterexpress.com!