Labels. Работа с лейблами
Здесь представлен исчерпывающий список лейблов для работы с issues в репозиториях. Список лейблов для всех проектов должен быть одинаков, за исключением Scope, т.к он для каждого проекта разный.
Что бы эффективно работать с issues, а также быстро их искать и различать, наша команда создала следующие виды issues:
- Priority
- Scope
- Type
Ниже каждый вид рассмотрен подробно.
Priority — приоритет. Этот лейбл по сути своей определяет важность того или иного issue. В процессе работы стало ясно что у нас нет нужды в 3 или более приоритетах, т.к это создает информационный шум и путаницу. По этой причине мы остановились на 2:
-
Normal, т.е нормальный. Приоритет при котором член команды может работать спокойно, приоритет задач выставляет менеджер проекта либо сам разработчик, если менеджер проекта недоступен. -
Critical, т.е критичный. Issue высшей важности. Когда появляется такой issue, нужно бросать все свои дела и задачи с приоритетомnormalи идти выполнять issue с приоритетомcritical. Обычно это происходит когда нужно форсировать какую-то задачу или когда происходит авария.
Выглядит приоритет следующим образом: Priority: Critical
- Normal —
#64dd17 - Critical —
#d50000
Scope или скоуп, это некие рамки, модули, подсистемы внутри системы или проекта. Обычно лейблы Scope определяет системный архитектор или back end разработчик. Scope лейблы нужны для того, что бы по смыслу отделять части системы и понимать какой issue к какой части системы относится. Это здорово помогает при навигации.
Выглядит это так: Scope: Scopename
Цвет Scope всегда
#ffffff
Отдельно стоит выделить Scope: DevOps. Данный скоуп есть в каждом проекте и это обязательно Scope. Не Type.
Так как сама сущность issue довольно податлива и гибка, мы добавили такой вид issue как Type, т.е тип. Тип помогает определить с чем имеет дело каждый член команды, например с багом (bug) или задачей (task) или обсуждением (discussion). Типы нужны для управления issues.
Выглядит это так: Type: Bug
В список Type входит:
- Bug Report — баг-репорт, регистрируется QA инженером для разработчиков и не только
- Bug — баг зарегистрированный любым членом команды, внешним юзером, заказчиком и так далее
- Discussion — дискуссия, обсуждение
- Documentation — документация
- Enhancement — улучшение
- Feature Request — запрос на фичу, регистрируется кем угодно
- Help Wanted — запрос на помощь, нужна помощь, помогити :(
- Info — у меня есть информация для вас
- Mindmap — майндмап для тестирования
- Optimization — оптимизация
- Question — вопрос
- Refactoring — рефактор
- Review — ревью
- Stand Up — стэндап
- Task — задача
- Test — тест
- User Story — юзер стори, пока не используется
Что бы управлять issues еще эффективней, лучше всего их группировать с помощью цветов. Цвет позволит быстро понять с каким type: issue член команды имеет дело. Ну и это банально удобно. Ниже приведена таблица с цветами type: issues.
| Color | HEX | Type of Issue | Description |
|---|---|---|---|
#d50000 |
Bug; Bug Report | Всё что относится к багам: баг репорт и баг | |
#ffedcc |
Discussion; Feature Request; Info; Help Wanted; Question; Review | Здесь лейблы которые относятся к взаимодействию, т.е обсуждение, дискуссия, вопрос. Когда нужно получить/передать информацию или обратную связь. | |
#ffca28 |
Documentation; Enhancement; Optimization; Refactoring; | Это лейблы которые относятся к рефактору, оптимизации, улучшению. Т.е те issue которые обычно бизнес «не видит». | |
#81d4fa |
Task; Test; Mindmap | Лейблы для задач (Task) и тестирования (Test) и майндмап (Mindmap) | |
#8e24aa |
Stand Up | Лейбл для стэндапа. Сугубо внутренняя и утилитарная вещь. | |
#eceff1 |
User Story | Лейбл для скоупа. Цвета нет. Эксперементальный лейбл. |
Данный лейбл генерируются автоматически с помощью расширения для браузера ZeHub. Рекомендую ознакомиться с расширением, оно здорово улучшает и расширяет функционал Github. Zenhub используется в нескольких наших проектах.
Этот лейбл проставляет renovate bot
Что бы добавить лейбл и не создать при этом путаницы нужно:
- Ознакомиться с текущей вики страницей и понять что такое лейблы и как они работают в контексте нашей команды
- Создать issue в репозитории https://github.com/AtlantisUnited/maintenance/ с лейблом
Feature Request - Подробно описать о чем этот лейбл и для каких целей он служит. Обязательно указать его
Scope - цветт.е к какой области он относится. Если такой области нет, описать новую область в которую вы хотите положить новый лейбл - Ждать фидбека
- Общими усилиями и с командой внедрить (или нет) новый лейбл