GitHub — это платформа для совместной работы

Завершено

Совместная работа находится в основе всего, что делает GitHub. Мы перешли к репозиториям в первом уроке модуля и узнали, что репозитории помогают упорядочивать проект и его файлы. В последнем модуле мы узнали о pull request’ах, которые позволяют отслеживать изменения, внесённые в ваш проект.

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

Проблемы

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

В этом пошаговом руководстве показано, как создать задачу в репозитории. Задачи также можно создавать из:

• Элемент в списке задач.
• Заметка в проекте.
• Комментарий в проблеме или запросе на включение изменений.
• Определенная строка кода.
• ЗАПРОС URL-адреса.

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

1. На сайте GitHub.com перейдите на главную страницу репозитория.

2. В поле имени репозитория выберите "Проблемы".

   

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

4. Если репозиторий использует шаблоны проблем, вы должны получить список типов проблем, выберите нужный.

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

   Если репозиторий использует формы проблем, вы увидите структурированную форму для заполнения вместо пустого шаблона проблемы. Формы для сообщений о проблемах позволяют сопровождающим собирать определённые сведения в стандартизованном формате.

   

5. В поле "Добавление заголовка" введите название проблемы.

6. В поле "Добавление описания" введите описание проблемы.

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

8. По завершении нажмите кнопку "Отправить новую проблему".

Используйте метки, упоминания и реакции для эффективного управления совместной работой и повышения видимости проблем. Шаблоны задач помогают обеспечивать единообразную структуру и единые ожидания для участников.

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

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

Обсуждения

Обсуждения предназначены для бесед, которые не обязательно привязаны к коду, например Q&A, идей или общих отзывов. Они поддерживают открытый, постоянный обмен данными на общем форуме и могут быть общедоступными или частными в зависимости от видимости репозитория.

Из этого раздела вы узнаете следующее:

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

Давайте разберём, как включить обсуждения в вашем репозитории.

Включение обсуждений в вашем репозитории

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

При первом включении обсуждений GitHub вам будет предложено настроить приветственное сообщение.

1. На сайте GitHub.com перейдите на главную страницу репозитория.

2. Под именем репозитория выберите Параметры.

   

3. Прокрутите вниз до раздела "Компоненты " и в разделе "Обсуждения" выберите пункт "Настройка обсуждений".

   

4. В разделе "Начать новое обсуждение" измените шаблон, чтобы он соответствовал тону и ресурсам сообщества.

5. Выберите " Начать обсуждение".

Теперь вы готовы создать новое обсуждение.

Создание нового обсуждения

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

1. На GitHub.com перейдите на главную страницу репозитория или организации, где нужно начать обсуждение.

2. Под именем репозитория или организации выберите "Обсуждения".

   

3. В правой части страницы выберите "Создать обсуждение".

4. Выберите категорию обсуждений, выбрав "Начать работу". Все обсуждения должны быть помещены в категорию. Хранители репозитория определяют эти категории.

   

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

Категория	Целевые назначения	Формат
📣 Объявления	Обновления и новости от разработчиков проекта	Объявление
#️⃣ Общее	Все, что имеет отношение к проекту	Открытое обсуждение
💡 Идеи	Идеи по изменению или улучшению проекта	Открытое обсуждение
🗳️ Опросы	Опросы с несколькими вариантами для голосования и обсуждения в сообществе	Опросы
🙏 Вопросы и ответы	Вопросы для сообщества, на которые нужно дать ответ, в формате "вопрос/ответ"	Вопросы и ответы
🙌 Показывайте и рассказывайте	Любые создания, эксперименты или тесты, относящиеся к проекту	Открытое обсуждение

Сопровождающие репозитория могут закрепить важные обсуждения вверху вкладки «Обсуждения» для лучшей видимости.

1. В разделе " Обсуждение" введите название для обсуждения и в разделе "Запись " введите текст обсуждения.

   

2. Выберите " Начать обсуждение".

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

Пометка комментария как ответа

В обсуждении стиля Q&A можно пометить комментарий как принятый ответ на исходный вопрос.

1. Перейдите к обсуждению.
2. Найдите комментарий, который лучше всего отвечает на исходный вопрос.
3. Выберите "Пометить как ответ " под комментарием.

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

Ссылка на обсуждение проблемы

Если обсуждение ведет к работе, которую необходимо отслеживать, можно преобразовать обсуждение в проблему.

1. Перейдите к обсуждению, которое вы хотите преобразовать.
2. ... Выберите меню (три точки) в правом верхнем углу обсуждения.
3. Выберите Упомянуть в новом обсуждении.
4. Подтвердите название и описание нового обращения.

Здесь отслеживаются задачи, требующие действий, которые возникают в результате обсуждений в сообществе.

Закрепление обсуждения

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

1. Перейдите к обсуждению, которое вы хотите закрепить.
2. ... Выберите меню (три точки) в правом верхнем углу обсуждения.
3. Выберите "Закрепить обсуждение".

Закреплённые обсуждения помогают выделить объявления, важные вопросы или актуальные темы, на которые сообществу стоит обратить внимание.