Введение
GitHub Enterprise Server предоставляет встроенные средства общения для совместной работы, чтобы вы могли взаимодействовать с сообществом. В этом кратком руководстве показано, как выбрать подходящее средство для ваших потребностей.
Вы можете создавать проблемы, запросы на вытягивание и обсуждения в команде, а также участвовать в них, в зависимости от требуемого типа обсуждения.
GitHub Issues
- удобны для обсуждения конкретных сведений о проекте, например для отчетов об ошибках, сведений о запланированных улучшениях и отзывов;
- относятся к конкретному репозиторию и обычно имеют конкретного владельца;
- часто называются системой отслеживания ошибок GitHub.
Запросы на вытягивание
- позволяют предлагать конкретные изменения;
- позволяют напрямую комментировать предложенные другими пользователями изменения;
- относятся к конкретному репозиторию.
Обсуждения в команде
- могут создаваться на странице обсуждения в команде, и могут охватывать несколько проектов без привязки к определенной проблеме или запросу на вытягивание. Вместо того, чтобы открыть вопрос в репозитории для обсуждения идеи, вы можете привлечь к беседе всю команду, проведя обсуждение в команде.
- позволяют проводить с командой обсуждения для планирования, анализа, проектирования, изучения реакции пользователей и принятия решений общего характера по проекту;
- обеспечивают совместную работу за пределами базы кода, позволяя проводить мозговой штурм идей;
- часто не имеют конкретного владельца;
- часто используются не для создания конкретной задачи.
Какие средства для обсуждений мне подходят?
Сценарии проблем
- Я хочу отслеживать задачи, улучшения и ошибки.
- Я хочу отправить отчет об ошибке.
- Я хочу поделиться отзывами о конкретной функции.
- Я хочу задать вопрос о файлах в репозитории.
Пример проблемы
В этом примере показано, как пользователь GitHub создает проблему в нашем репозитории с открытым кодом для документации, чтобы сообщить об ошибке и обсудить исправление.
- Пользователь заметил, что синий цвет баннера в верхней части страницы в китайской версии документов GitHub делает текст баннера нечитаемым.
- Пользователь создал в репозитории проблему с описанием ситуации и предложил решение (использовать для баннера другой цвет фона).
- По этому решению проводится обсуждение и достигается консенсус.
- Затем участник может создать запрос на вытягивание с исправлением.
Сценарии для запросов на вытягивание
- Я хочу исправить опечатку в репозитории.
- Я хочу внести изменения в репозиторий.
- Я хочу внести изменения, чтобы устранить проблему.
- Я хочу комментировать изменения, предложенные другими.
Пример для запроса на вытягивание
В этом примере показано, как пользователь GitHub создал запрос на вытягивание в нашем репозитории с открытым кодом для документации, чтобы исправить опечатку.
На вкладке Обсуждение для запроса на вытягивание автор объясняет, почему он создал этот запрос на вытягивание.
На вкладке Измененные файлы для на вытягивание отображается внесенное исправление.
- Этот участник замечает опечатку в репозитории.
- Этот пользователь создает запрос на вытягивание с исправлением.
- Хранитель репозитория проверяет запрос на вытягивание, изучает комментарии к нему и объединяет его.
Сценарии для обсуждений в команде
- У меня есть вопрос, который не связан с конкретными файлами в репозитории.
- Я хочу делиться новостями с коллегами или командой.
- Я хочу начать открытую беседу или стать ее участником.
- Я хочу сделать объявление для своей команды.
Пример обсуждения в команде
В этом примере показана запись в обсуждении для команды octo-team.
Участник команды octocat опубликовал обсуждение в команде, чтобы проинформировать всех ее участников о нескольких вещах.
- Участник команды Mona начал события для удаленной игры.
- Есть запись блога с описанием того, как команды используют GitHub Actions для создания своих документов.
- Материал о мероприятии April All Hands теперь доступен для просмотра всем участникам команды.
Дальнейшие действия
На этих примерах вы узнали, как выбрать оптимальный инструмент для обсуждения в GitHub Enterprise Server. Но это только начало, ведь у вас есть много возможностей адаптировать эти средства под ваши потребности.
Для проблем: можно присвоить проблемам метки для быстрого поиска или создать шаблоны проблем, чтобы помочь участникам открывать проблемы с подробным описанием. Дополнительные сведения см. в разделах О проблемах и Сведения о шаблонах проблем и запросов на вытягивание.
Для запросов на вытягивание: можно создать черновик запросов на вытягивание, если работа над предлагаемыми изменениями может затянуться. Черновик запросов на вытягивание не может быть объединен, пока не будет помечен как готовый к проверке. Дополнительные сведения см. в разделе Сведения о запросах на вытягивание.
Для обсуждений в команде: можно редактировать или удалять обсуждения на странице команды, а также настраивать уведомления для обсуждений в команде. Дополнительные сведения см. в разделе Сведения об обсуждениях в команде.
Дополнительные сведения о функциях форматирования, которые помогут вам общаться, см. в разделе Краткое руководство по написанию на GitHub.