Issue Templates. Работа с шаблонами issue

Описание

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

Из чего состоит шаблон

Обычно шаблон состоит из:

• Имени
• Описания (about)
• Содержимое. Предустановленный контент внутри body
• Заранее прикрепленные лейблы
• Префикс в названии вида [untitled text]
• Заранее установленный assignee в случаях когда это нужно

Особенности некоторых шаблонов

Некоторые шаблоны имеют узкую направленность, например шаблоны Bug Report и Regression Testing предназначены только для QA инженера. Шаблон Stand Up имеется только в репозитории команды и предназначен для служебных целей.

Список шаблонов

№	Name of issue template	Prefix	About
1	Bug Report	[bug report]	Баг репорт от QA инженера для разработчика.
2	Feature Request	[feature request]	Запрос на новую фичу от кого угодно. Используется когда нужна новая фича для системы.
3	I Found A Bug	[bug]	Я нашел баг и хочу его зарегистрировать!
4	Regression Testing	[regression testing]	Регрессионное тестирование. Шаблон для QA инженера.
5	Stand Up	[stand up]	Стэндап. Шаблон для репозитория команды.
6	Task	[task]	Шаблон issue когда нужно чтобы кто-то что-то сделал :)
7	Team Meeting	[team meeting]	Командный митинг. Этот шаблон нужен тогда, когда нужно собрать 3+ людей для обсуждения каких-либо дел и при этом нужно зафиксировать всю информацию.

Я хочу добавить новый шаблон

Что бы добавить новый шаблон в проект нужно:

1. Ознакомиться с текущей wiki страницей
2. Создать issue feature request, добавить лейбл discussion
3. Расписать всю информацию о новом шаблоне issue. Продумать: префикс если нужен, содержимое если нужно, assignee и лейблы
4. Получить фидбек от коллег
5. Если предложение пройдет, то менеджер проекта или Андрей Гостюхин создаст новый шаблон

Рекомендации при предложении создания нового шаблона

Общие

Подумайте хорошо так ли нужен новый шаблон? Какие цели и задачи он решает? Может быть есть похожий по смыслу шаблон? Или существующий шаблон нуждается в пересмотре и реформе?

Лейблы

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

Префикс

Будет круто если у нового шаблона будет префикс вида [untitled prefix], это поможет при работе со списком issues.

Содержимое шаблона

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

Assignee

Некоторые шаблон могут содержать в себе предустановленный assignee, т.е исполнителя. Но прежде чем это сделать, вам нужно согласовать этот момент с предполагаемым исполнителем.

Wiki и проекты

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