Мы приветствуем ваше участие, чтобы помочь улучшить документацию Zadig.
Чтобы обеспечить согласованность документации, мы просим всех участников следовать нашему руководству по написанию документации. Это руководство подробно описывает следующие аспекты написания документации:
Документация Zadig публикуется на сайте docs.koderover.com, и вы можете участвовать в её создании несколькими способами.
На каждой странице сайта документации в правом верхнем углу меню есть опции «Редактировать документ» и «Обратная связь», которые позволяют перейти к странице редактирования соответствующего документа на GitHub или к странице Issue. Вы также можете напрямую обратиться к странице Issue на GitHub для отправки вопросов.
Обратите внимание: если вы отправляете вопросы непосредственно на страницу Issue в репозитории документации, пожалуйста, укажите ссылку на страницу документа.
Как показано на рисунке выше, после нажатия на опцию «Редактировать эту страницу» в правом верхнем углу сайта документации вы будете перенаправлены на следующую страницу GitHub, где вам нужно будет нажать «Fork this repository».
Fork репозитория документации koderover/zadig-doc на свой аккаунт.
Клонируйте репозиторий документации на локальный компьютер и добавьте Remote.
git clone https://github.com/yourgithubname/zadig-doc
git remote add upstream https://github.com/koderover/zadig-doc.git
Определите версию документа, перейдите в соответствующую папку для редактирования, следуя правилам: 1.7.0 соответствует версии v1.7.0, 1.6.0 — версии v1.6.0 и так далее.
cd 1.7.0
После завершения работы отправьте изменения.
Создайте Pull Request из своего Fork-репозитория в вышестоящий репозиторий https://github.com/koderover/zadig-doc.
Если у вас возникли проблемы при внесении вклада в документацию, вы можете связаться с нами следующими способами:
Slack-группа | Join Zadig |
GitHub Issue | Create new issues |
Вы можете оставить комментарий после Вход в систему
Неприемлемый контент может быть отображен здесь и не будет показан на странице. Вы можете проверить и изменить его с помощью соответствующей функции редактирования.
Если вы подтверждаете, что содержание не содержит непристойной лексики/перенаправления на рекламу/насилия/вульгарной порнографии/нарушений/пиратства/ложного/незначительного или незаконного контента, связанного с национальными законами и предписаниями, вы можете нажать «Отправить» для подачи апелляции, и мы обработаем ее как можно скорее.
Опубликовать ( 0 )