Создание проблем с GitHub для продуктов с открытым кодом

В этой статье описано, как создать проблему GitHub для документации Microsoft Learn, связанной с продуктами с открытым исходным кодом. Он также учит вас, как использовать проблемы других пользователей и добавлять к ним собственные комментарии или открывать запрос на вытягивание (PR) для их решения.

Наша документация по продукту с открытым кодом — это непрерывная работа. Получение хороших вопросов GitHub от участников помогает нам сосредоточить наши усилия на самых высоких приоритетах для сообщества.

Конечно, если вы знаете, как устранить проблему, мы пригласим вас внести изменения самостоятельно, а не открыть проблему.

Примечание.

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

Необходимые компоненты

• Создайте учетную запись GitHub, если у вас нет учетной записи.

Создание проблемы

1. Перейдите к статье, о которой вы хотите комментировать.

2. Прокрутите страницу до нижней части статьи, где вы увидите варианты отправки отзывов. Выберите " Открыть проблему с документацией", чтобы создать новую проблему. Эта обратная связь относится к содержимому и отслеживается как проблема в GitHub.

   

   При необходимости выберите "Предоставить отзыв о продукте", чтобы перейти к месту назначения (например, портал отзывов, GitHub, адрес электронной почты), где можно предоставить отзыв о самом продукте. Эта обратная связь не зависит от содержимого и не имеет отношения к исходной статье.

3. Система открывает новую проблему для вас в репозитории GitHub, в которой хранится содержимое для просматриваемой статьи. Добавление заголовка и описания; Все остальные поля должны заполняться автоматически. После завершения нажмите кнопку "Отправить новую проблему".

   

   Чем более подробно вы предоставляете, тем более полезной проблемой является. Расскажите нам, какие сведения вы искали или какие условия поиска вы использовали для получения этой статьи. Если вы не знаете, с чего начать, расскажите о том, с чего вы хотели бы начать знакомство с новой технологией. Вы также можете добавить снимки экрана или файлы, чтобы помочь нам понять вашу проблему.

Вот и все! Теперь проблема добавлена в очередь проблем. Чтобы понять ваши потребности, нам необходимы ваши отзывы. Команда содержимого ответит на эти вопросы с идеями о том, что мы можем добавить и попросить ваши мнения.

Комментарий по проблеме

Вы можете закомментировать любую проблему в репозитории, поддерживающем проблемы GitHub. Вы также можете добавить собственные комментарии к созданной проблеме.

1. Найдите проблему, о которой вы хотите комментировать. В браузере перейдите к репозиторию GitHub, для которого нужно найти проблемы. Перейдите на вкладку "Проблемы", чтобы просмотреть открытые проблемы для этого репозитория. Если репозиторий имеет много проблем, используйте панель фильтров для фильтрации по меткам, автору и т. д. Или используйте панель поиска для поиска конкретных запросов. Когда вы найдете проблему, которая обращается к вам, выберите ее, чтобы открыть ее.

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

2. Ознакомьтесь с проблемой и любыми комментариями, которые уже были добавлены другими пользователями. Если вы хотите добавить комментарий, прокрутите страницу внизу проблемы и введите комментарий в поле "Оставьте комментарий ". По завершении нажмите кнопку "Комментарий".

   

Открытие запроса на вытягивание для решения проблем

При просмотре проблем вы можете найти тот, который вы знаете, как устранить. Если это так, вы можете открыть PR для решения проблемы. Дополнительные сведения см. в документации по редактированию в браузере.

После открытия pr для решения проблемы вернитесь к проблеме и добавьте комментарий, который ссылается на ваш PR. Это помогает нам отслеживать проблему и PR вместе. Используйте знак фунта (#), за которым следует номер PR, чтобы связаться с PR. Например, если номер PR равен 4210, вы введите #4210 комментарий.