Issues
Issues — это место где мы обсуждаем всю важную работу, от начала (создание issue) и до конца (закрытие issue).
Важно чтобы обсуждение по той или иной задаче/проблеме проходило внутри Issue. Это позволяет отследить историю в случае возникновения такой проблемы, а также даёт возможность просто делиться ссылкой на Issue или конкретный комментарий внутри Issue.
Сам по себе Issue не несёт никакого «смыслового окраса». Для этого, мы применяем лейблы.
Например:
- Issue с лейблом documents — это задача или проблема, которая относится к документации
- Issue с лейблом feature — означает что там лежит какая-то информация о фиче
- Issue с лейблом bug, ну ты понял
Поэтому очень желательно, чтобы Issues не оставались без лейблов. Список доступных лейблов доступен с правой стороны Issue, заголовок Labels:
Управление Лейблами на GitHub Docs
Майлстоун - это цель, этап в текущей работе, который объединяет в себе issues и pull request. С его помощью мы можем:
- разбить проект на куски, по доменам или фичам (логическим блокам)
- каждому куску назначить таски и сроки
Майлстоун позволит контролировать прогресс выполнения задач, а так же сопоставлять текущую ситуацию с планом по срокам.
- Каждая
Issueдолжна быть оформлена по шаблону - баг, фича, chore, documentation и т.д. Обычно в наших репозиториях идут шаблоны. Если нет, можно взять -
Issueобязательно должна быть привязана кMilestone. Если нужного нет - создать, проставить сроки. - Если в проекте есть
Project- связать и указать статус.
- Если работа по
Issueначата, но не завершена, а рабочий день закончился или вам надо переключиться на другую задачу - необходимо комментарием описать текущий прогресс и дальнейшие планы. Пример