Введение
В этом руководстве показано, как GitHub Issues планировать и отслеживать работу. В этом руководстве вы создадите новый выпуск и разбиете его на подвыпуски. Вы также научитесь добавлять ярлыки, типы проблем, этапы, назначенных лиц и проекты для передачи метаданных о вашей проблеме.
Необходимые компоненты
Чтобы создать проблему, вам потребуется репозиторий. Вы можете использовать существующий репозиторий, к которому у вас есть доступ для записи, или создать репозиторий. В репозитории должны быть включены проблемы. Дополнительные сведения о создании репозитория см. в разделе Создание репозитория. Дополнительные сведения о включении проблем, если они отключены в репозитории, см. в разделе Отключение проблем.
Открытие пустой проблемы
Сначала создайте проблему. Существует несколько способов создавать проблемы, и вы можете выбрать наиболее подходящий для вашего рабочего процесса. В этом примере будет использован интерфейс GitHub . Дополнительные сведения о других способах создания проблемы см. в разделе Создание проблемы.
-
На GitHubперейдите на главную страницу репозитория.
-
В поле имени репозитория щелкните Issues.
-
Щелкните Новая проблема.
-
В этом примере мы начнем с пустой проблемы. Ваш репозиторий может использовать шаблоны выпусков, чтобы побудить участников предоставлять конкретную информацию. Если репозиторий использует шаблоны проблем, нажмите кнопку "Открыть пустую проблему".
Заполнение сведений
Присвойте вашей проблеме описательное название. Это название должно с первого взгляда дать общее понимание контекста.
Добавьте описание, которое объясняет назначение проблемы, и добавьте в него все сведения, которые могут помочь в устранении проблемы. Например, если вы оформляете отчет об ошибке, опишите шаги для воспроизведения ошибки, ожидаемый и фактический результаты.
Вы можете использовать разметку Markdown для форматирования, ссылок, смайликов и так далее. Дополнительные сведения см. в разделе Создание документов на GitHub.
Добавление списка задач
Вы также можете использовать обычный текст для отслеживания задач, которые не имеют соответствующей проблемы, и преобразовать их в проблемы позже. Дополнительные сведения см. в разделе Сведения о списках задач.
Назначение проблемы
Чтобы обозначить зоны ответственности, вы можете назначить проблему определенному участнику в организации. См . раздел AUTOTITLE.
Добавление меток
Добавьте метку для классификации проблемы. Например, можно использовать question метку и good first issue метку, чтобы указать, что проблема является вопросом, который первый раз участник может забрать. Пользователи могут фильтровать проблемы по меткам, чтобы получить все проблемы с определенной меткой.
Вы можете использовать стандартные метки или создать собственные. Дополнительные сведения см. в разделе Управление метками.
Добавление типов проблем
Вы можете добавить тип проблемы для классификации работы в организации. См . раздел AUTOTITLE.
Добавление проблемы в проект
Вы можете добавить проблему в существующий проект и заполнить метаданные для проекта. Дополнительные сведения о проектах см. в разделе Около Projects.
Добавление вех
Вы можете добавить веху для отслеживания проблемы в рамках целевого объекта на основе дат. Веха показывает ход выполнения проблем в качестве подхода к целевой дате. См . раздел AUTOTITLE.
Отправка проблемы
Щелкните Отправить новую проблему, чтобы создать проблему. После создания проблемы можно изменить любое из описанных выше полей. У вашей проблемы есть уникальный URL-адрес, который можно передать другим участникам команды, указать в описании других проблем или запросов на вытягивание.
Добавление вложенных проблем
Вы можете добавить вложенные проблемы в проблему, чтобы быстро разбить большие части работы на небольшие проблемы. Вложенные проблемы добавляют поддержку иерархий проблем на GitHub путем создания связей между проблемами. Вы можете создать несколько уровней вложенных проблем, которые точно представляют проект, разбив задачи на точное количество необходимых вам и вашей команде сведений. См. Добавление вложенных проблем и Просмотр вложенных проблем.
Добавление зависимостей проблем
Можно определить блокирующие связи между проблемами с помощью зависимостей проблем. Зависимости проблем позволяют выявлять проблемы, которые блокируются или блокируются другими рабочими возможностями. См . раздел AUTOTITLE.
Взаимодействие
После создания проблемы продолжайте общение, добавляя комментарии к проблеме. Вы можете указать коллег или команды в @mention, чтобы привлечь их внимание к комментариям. Чтобы связать связанные проблемы в том же репозитории, можно ввести # перед заголовком проблемы, а затем щелкнуть проблему, которую нужно связать. Дополнительные сведения см. в разделе Создание документов на GitHub.
Следующие шаги
Проблемы можно использовать для широкого спектра задач. Например:
- Отслеживание идей
- Сбор отзывов
- Задачи по планированию
- Информирование об ошибках
Чтобы разбить проблему на более управляемые задачи, можно добавить несколько уровней вложенных проблем. См . раздел AUTOTITLE.
Вот несколько полезных ресурсов, чтобы сделать следующие шаги с GitHub Issues:
- Дополнительные сведения о проблемах см. в разделе О проблемах.
- Чтобы узнать о основах использования GitHubинструментов планирования и отслеживания, смотрите Планирование и отслеживание работы для команды или проекта.
- Дополнительные сведения о том, как проекты помогут вам с планированием и отслеживанием, см. в статье Сведения о Projects.
- Чтобы узнать больше об использовании шаблонов выпусков для поощрения участников предоставлять конкретную информацию, смотрите Использование шаблонов для описания важных проблем и выполнения запросов на вытягивание.