Взаимодействие с GitHub

Введение

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

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

GitHub Issues

• Полезны для обсуждения конкретных сведений о проекте, таких как отчеты об ошибках, запланированные улучшения и отзывы
• Относятся к репозиторию и обычно имеют четкого владельца
• Часто называются системой отслеживания ошибок GitHub.

Запросы на включение внесенных изменений

• Разрешить предлагать конкретные изменения
• Разрешить комментировать предлагаемые другими пользователями изменения напрямую
• Относятся к репозиторию

GitHub Discussions

• Как форум, и лучше всего использовать для открытых идей и обсуждений, где совместная работа важна
• Может охватывать множество репозиториев
• Предоставление совместной работы за пределами базы кода, позволяя мозговой штурм идей и создание сообщества база знаний
• Часто у вас нет четкого владельца
• Часто не приводит к выполнению задачи

Какие средства для обсуждений мне подходят?

Сценарии проблем

• Я хочу отслеживать задачи, улучшения и ошибки.
• Я хочу отправить отчет об ошибке.
• Я хочу поделиться отзывами о конкретной функции.
• Я хочу задать вопрос о файлах в репозитории.

Пример проблемы

В этом примере показано, как пользователь GitHub создает проблему в нашем репозитории с открытым кодом для документации, чтобы сообщить об ошибке и обсудить исправление.

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

Сценарии для запросов на вытягивание

• Я хочу исправить опечатку в репозитории.
• Я хочу внести изменения в репозиторий.
• Я хочу внести изменения, чтобы устранить проблему.
• Я хочу комментировать изменения, предложенные другими.

Пример для запроса на вытягивание

В этом примере показано, как пользователь GitHub создал запрос на вытягивание в нашем репозитории с открытым кодом для документации, чтобы исправить опечатку.

На вкладке Обсуждение для запроса на вытягивание автор объясняет, почему он создал этот запрос на вытягивание.

На вкладке Измененные файлы для на вытягивание отображается внесенное исправление.

• Этот участник замечает опечатку в репозитории.
• Этот пользователь создает запрос на вытягивание с исправлением.
• Хранитель репозитория проверяет запрос на вытягивание, изучает комментарии к нему и объединяет его.

Сценарии для GitHub Discussions

• У меня есть вопрос, который не связан с конкретными файлами в репозитории.
• Я хочу делиться новостями с коллегами или командой.
• Я хочу начать открытую беседу или стать ее участником.
• Я хочу сделать объявление в сообществе.

Пример GitHub Discussions

В этом примере показано создание приветственной записи в GitHub Discussions для репозитория GitHub с открытым кодом для документации, и описаны предпочтительные методы общения в сообществе для команды.

Этот хранитель сообщества начал обсуждение, чтобы приветствовать участников и предложить всем представиться. Такая запись способствует созданию комфортной атмосферы для посетителей и участников. В этом же сообщении объясняется, что команда будет рада помочь в создании вкладов в репозиторий.

Использование Copilot для получения контекста

Если вам нужно больше контекста или ясности по определенной проблеме или обсуждению, можно использовать GitHub Copilot для ответа на ваши вопросы. Это позволяет быстро получать аналитические сведения, понимать сложные потоки и оставаться в соответствии с целями проекта, обеспечивая совместную работу и обмен знаниями в сообществе.

Чтобы задать вопрос о проблеме или обсуждении:

1. В любом месте в GitHubщелкните значок GitHub Copilot рядом с строкой поиска в правом верхнем углу страницы.

   

2. В поле "Задать Copilot" введите вопрос и добавьте соответствующий URL-адрес в сообщение. Например, можно попросить:

   • Explain https://github.com/monalisa/octokit/issues/1
   • Summarize https://github.com/monalisa/octokit/discussions/4
   • Recommend next steps for https://github.com/monalisa/octokit/issues/2
   • What are the acceptance criteria for ISSUE URL?
   • What are the main points made by PERSON in DISCUSSION URL?

   Если вы беседуете с GitHub Copilot из определенной проблемы или обсуждения, вам не нужно включать URL-адрес в свой вопрос.

3. При необходимости после отправки вопроса можно щелкнуть в текстовом поле, чтобы остановить ответ.

Следующие шаги

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

Для проблем: можно присвоить проблемам метки для быстрого поиска или создать шаблоны проблем, чтобы помочь участникам открывать проблемы с подробным описанием. Дополнительные сведения см. в разделе [AUTOTITLE и О проблемах](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates).

Для запросов на вытягивание: можно создать черновик запросов на вытягивание, если работа над предлагаемыми изменениями может затянуться. Черновик запросов на вытягивание не может быть объединен, пока не будет помечен как готовый к проверке. Дополнительные сведения см. в разделе Сведения о запросах на вытягивание.

Для GitHub Discussionsвы можете настроить код поведения и закрепить обсуждения, содержащие важную информацию для вашего сообщества. Дополнительные сведения см. в разделе Сведения об обсуждениях.

Дополнительные сведения о функциях форматирования, которые помогут вам взаимодействовать, см. в разделе Краткое руководство по написанию на сайте GitHub.