1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/koderover-zadig-doc

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Клонировать/Скачать
CONTRIBUTING-CN.md 5.1 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
gitlife-traslator Отправлено 30.11.2024 13:49 5ccffec

Руководство по внесению вклада в документацию Zadig

Мы приветствуем ваше участие, чтобы помочь улучшить документацию Zadig.

Содержание

  • [Руководство по написанию документации](#Руководство по написанию документации)
  • [Как внести вклад в документацию](#Как внести вклад в документацию)
    • [Обратная связь по вопросам](#Обратная связь по вопросам)
    • Онлайн-редактирование
    • [Локальное редактирование](#Локальное редактирование)
  • [Поиск помощи](#Поиск помощи)

Руководство по написанию документации

Чтобы обеспечить согласованность документации, мы просим всех участников следовать нашему руководству по написанию документации. Это руководство подробно описывает следующие аспекты написания документации:

  • [Конфигурация каталога](./DOCS-WRITING-GUIDE-CN.md#Конфигурация каталога)
  • [Правила написания Markdown](./DOCS-WRITING-GUIDE-CN.md#Правила написания Markdown)
  • [Расширения синтаксиса](./DOCS-WRITING-GUIDE-CN.md#Расширения синтаксиса)

Как внести вклад в документацию

Документация Zadig публикуется на сайте docs.koderover.com, и вы можете участвовать в её создании несколькими способами.

Обратная связь по вопросам

edit-online-cn

На каждой странице сайта документации в правом верхнем углу меню есть опции «Редактировать документ» и «Обратная связь», которые позволяют перейти к странице редактирования соответствующего документа на GitHub или к странице Issue. Вы также можете напрямую обратиться к странице Issue на GitHub для отправки вопросов.

Обратите внимание: если вы отправляете вопросы непосредственно на страницу Issue в репозитории документации, пожалуйста, укажите ссылку на страницу документа.

Онлайн-редактирование

Fork

Как показано на рисунке выше, после нажатия на опцию «Редактировать эту страницу» в правом верхнем углу сайта документации вы будете перенаправлены на следующую страницу GitHub, где вам нужно будет нажать «Fork this repository».

fork

Локальное редактирование

  1. Fork репозитория документации koderover/zadig-doc на свой аккаунт.

  2. Клонируйте репозиторий документации на локальный компьютер и добавьте Remote.

    git clone https://github.com/yourgithubname/zadig-doc
    git remote add upstream https://github.com/koderover/zadig-doc.git
  3. Определите версию документа, перейдите в соответствующую папку для редактирования, следуя правилам: 1.7.0 соответствует версии v1.7.0, 1.6.0 — версии v1.6.0 и так далее.

    cd 1.7.0
  4. После завершения работы отправьте изменения.

  5. Создайте Pull Request из своего Fork-репозитория в вышестоящий репозиторий https://github.com/koderover/zadig-doc.

Поиск помощи

Если у вас возникли проблемы при внесении вклада в документацию, вы можете связаться с нами следующими способами:

Slack-группа Join Zadig
GitHub Issue Create new issues

Опубликовать ( 0 )

Вы можете оставить комментарий после Вход в систему

1
https://api.gitlife.ru/oschina-mirror/koderover-zadig-doc.git
git@api.gitlife.ru:oschina-mirror/koderover-zadig-doc.git
oschina-mirror
koderover-zadig-doc
koderover-zadig-doc
main