Введение
GitHub Предоставляет встроенные инструменты для совместной коммуникации, позволяющие тесно взаимодействовать с вашим сообществом. В этом кратком руководстве показано, как выбрать подходящее средство для ваших потребностей.
Вы можете создавать и участвовать в проблемах, запросах на вытягивание и обсуждениях команды в зависимости от типа беседы, которую вы хотите иметь.
GitHub Issues
- Полезны для обсуждения конкретных сведений о проекте, таких как отчеты об ошибках, запланированные улучшения и отзывы
- Относятся к репозиторию и обычно имеют четкого владельца
- Часто называются GitHubсистемой отслеживания ошибок
Запросы на включение внесенных изменений
- Разрешить предлагать конкретные изменения
- Разрешить комментировать предлагаемые другими пользователями изменения напрямую
- Относятся к репозиторию
Какие средства для обсуждений мне подходят?
Сценарии проблем
- Я хочу отслеживать задачи, улучшения и ошибки.
- Я хочу отправить отчет об ошибке.
- Я хочу поделиться отзывами о конкретной функции.
- Я хочу задать вопрос о файлах в репозитории.
Пример проблемы
Этот пример иллюстрирует, как GitHub пользователь создал проблему в нашем репозитории документации открытый код, чтобы мы уведомили об ошибке и обсудили исправление.
- Пользователь заметил, что синий цвет баннера в верхней части страницы в китайской версии GitHub Docs делает текст в баннере нечитаемым.
- Пользователь создал в репозитории проблему с описанием ситуации и предложил решение (использовать для баннера другой цвет фона).
- По этому решению проводится обсуждение и достигается консенсус.
- Затем участник может создать запрос на вытягивание с исправлением.
Сценарии для запросов на вытягивание
- Я хочу исправить опечатку в репозитории.
- Я хочу внести изменения в репозиторий.
- Я хочу внести изменения, чтобы устранить проблему.
- Я хочу комментировать изменения, предложенные другими.
Пример для запроса на вытягивание
Этот пример иллюстрирует, как GitHub пользователь создал pull request в нашем репозитории документации открытый код для исправления опечатки.
На вкладке Обсуждение для запроса на вытягивание автор объясняет, почему он создал этот запрос на вытягивание.
На вкладке Измененные файлы для на вытягивание отображается внесенное исправление.
- Этот участник замечает опечатку в репозитории.
- Этот пользователь создает запрос на вытягивание с исправлением.
- Хранитель репозитория проверяет запрос на вытягивание, изучает комментарии к нему и объединяет его.
Сценарии для GitHub Discussions
- У меня есть вопрос, который не связан с конкретными файлами в репозитории.
- Я хочу делиться новостями с коллегами или командой.
- Я хочу начать открытую беседу или стать ее участником.
- Я хочу сделать объявление в сообществе.
пример GitHub Discussions
Этот пример показывает GitHub Discussions приветственный пост для GitHub репозитория открытый код Docs и иллюстрирует, как команда хочет сотрудничать со своим сообществом.
Этот хранитель сообщества начал обсуждение, чтобы приветствовать участников и предложить всем представиться. Такая запись способствует созданию комфортной атмосферы для посетителей и участников. В этом же сообщении объясняется, что команда будет рада помочь в создании вкладов в репозиторий.
Следующие шаги
Эти примеры показали, как решить, какой инструмент лучше всего подходит для ваших разговоров на GitHub. Но это только начало, ведь у вас есть много возможностей адаптировать эти средства под ваши потребности.
Для проблем: можно присвоить проблемам метки для быстрого поиска или создать шаблоны проблем, чтобы помочь участникам открывать проблемы с подробным описанием. Дополнительные сведения см. в разделе [AUTOTITLE и О проблемах](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates).
Для запросов на вытягивание: можно создать черновик запросов на вытягивание, если работа над предлагаемыми изменениями может затянуться. Черновик запросов на вытягивание не может быть объединен, пока не будет помечен как готовый к проверке. Дополнительные сведения см. в разделе Сведения о запросах на вытягивание.
Для GitHub Discussions, вы можете прикреплять обсуждения, содержащие важную информацию для вашего сообщества. Дополнительные сведения см. в разделе Сведения об обсуждениях.
Дополнительные сведения о функциях форматирования, которые помогут вам взаимодействовать, см. в разделе Быстрый старт для написания на GitHub.