Skip to content

GitHub Projects instruction

Jump to bottom
Pronich edited this page Oct 29, 2021 · 6 revisions

Инструкция по работе с GitHub Projects и issues

Типы задач

Чтобы мы могли отличать задачи друг от друга, можно использовать Labels. На текущий момент предлагаю использовать 4 варианта Labels: Labels

  • Feature - новый функционал, которые добавляем в наш проект. Фича должна описывать конечную функциональность, которую можно протестировать и проверить работоспособность
  • SubTask - Подзадача к фиче, описывающая часть функционала.
Пример
Features - Реализовать REST API
SubTask - реализовать логику Get-метода. Вытащить данные из БД, собрать в нужный вид и вернуть ответ
  • Bug - Если после влития в master и в момент тестирования находим ошибку в работе сервиса
  • Documentation - Задачи, не связанные напрямую с кодовой базой. Документация к проекту, проектирование БД

Как создавать задачи

Для того, чтобы задачи были в правильном формате - лучший способ заводить задачи через вкладку Issues. В этом случае мы сразу создаем Issues, а не Note (через вкладку Projects на доске создаются именно Notes). Далее заполняем все по порядку:

  1. Заполняем название задачи
  2. Описываем информацию по задаче с помощью MarkDown (одно из лучших описаний можно найти на этом сайте)
  3. Проставляем Assignees, если знаете, на кого назначить задачу. Если задача для Backlog, то оставляем поле пустым
  4. Помечаем Label (выбираем 1 из вариантов: Feature, Bug, Documentation). SubTask создаются разработчиками в момент планирования задачи
  5. Выбираем Projects

Связи задач

К сожалению в GitHub придется немного пострадать с этим

Для того, чтобы привязать SubTask к основной задаче, необходимо в поле Description основной задачи прописать - [ ] #<номер задачи>. После сохранения вид основной задачи изменится на следующий: Подзадачи

Как только Subtask будет выполнен, и прожата кнопка "Close Issues" - статус чек-бокса автоматически изменится на "Выполнен".

Clone this wiki locally