Поделиться через

Участие в документации по PowerShell

Спасибо за поддержку PowerShell!

Руководство участника — это коллекция статей, описывающих инструменты и процессы, которые мы используем для создания документации в Корпорации Майкрософт. Некоторые из этих руководств охватывают сведения, общие для любой документации, опубликованной в learn.microsoft.com. Другие руководства относятся к написанию документации по PowerShell.

Общие статьи доступны в нашем централизованном руководстве участника. Специфичные для PowerShell справочники доступны здесь.

Способы внесения вклада

Существует два способа внести свой вклад. Оба вклада являются ценными для нас.

  • Сообщение о проблемах помогает нам выявлять проблемы и пробелы в нашей документации. Иногда проблемы трудно решить, требуя дальнейшего расследования и изучения. Процесс проблемы позволяет нам беседовать о проблеме и разрабатывать удовлетворительное решение.

  • Отправка pull-реквеста для добавления или изменения содержимого требует более активного участия. Следующая информация содержит сведения о средствах, процессах и стандартах для отправки содержимого в документацию.

Подготовка к внесению вклада

Для участия в документации требуется учетная запись GitHub. Используйте следующий контрольный список, чтобы установить и настроить инструменты, необходимые вам для внесения вкладов.

  1. Регистрация на сайте GitHub
  2. Установка средств Git и Markdown
  3. Установка пакета разработки документов
  4. Установка Posh-Git — не требуется, но рекомендуется
  5. Настройка локального репозитория Git
  6. Ознакомьтесь с основами Git и GitHub

Приступая к работе с документацией

Существует два способа внести изменения в документацию:

  1. Быстрые изменения в существующих документах — незначительные исправления, исправление опечаток или небольшие дополнения
  2. Полный рабочий процесс GitHub для документов : большие изменения, несколько версий, добавление или изменение изображений или внесение новых статей

Кроме того, ознакомьтесь с разделом "Основы написания" в централизованном "Руководстве для участников". Другой отличный ресурс — руководство по стилю записи Майкрософт.

Незначительные исправления или пояснения к документации и примерам кода в общедоступных репозиториях охватываются Условиями использования learn.microsoft.com.

При внесении существенных изменений используйте полный рабочий процесс GitHub. Если вы не являетесь сотрудником корпорации Майкрософт, наша система проверки PR добавляет комментарий к pull request с просьбой подписать соглашение о лицензировании вкладов в интернет (CLA). Прежде чем мы сможем просмотреть или принять ваш запрос на вытягивание, необходимо выполнить этот шаг. Подписывание соглашения об уровне обслуживания требуется только при первом отправке pr в репозитории. Вам может потребоваться подписать соглашение об уровне обслуживания для каждого участия в новом репозитории.

Кодекс поведения

Все репозитории, которые публикуются в Microsoft Learn, соответствуют Кодексу поведения Microsoft Open SourceИли Кодексу поведения .NET Foundation. Дополнительные сведения см. в разделе "Часто задаваемые вопросы о кодексе поведения".

Дальнейшие шаги

В следующих статьях содержатся сведения, относящиеся к документации по PowerShell. Если в централизованном руководстве для участников есть совпадения, мы указываем, как эти правила отличаются для содержимого PowerShell.

Ознакомьтесь со следующими документами:

Дополнительные ресурсы