Ответ
Заголовок (Summary/Title) баг-репорта — это его краткая и самая видимая часть. Он должен быть:
- Кратким и конкретным: Умещаться в одну строку, без лишних деталей.
- Информативным и уникальным: Позволять однозначно идентифицировать проблему среди других.
- Объективным: Описывать наблюдаемое поведение, а не предположения о причине.
- Структурированным (рекомендуется): Следовать шаблону
[ГДЕ?] [ЧТО?] [ПРИ КАКИХ УСЛОВИЯХ?].
Хорошие примеры:
[Главная страница] Кнопка 'Отправить' неактивна после очистки обязательного поля 'Email'[Корзина] Итоговая сумма рассчитывается некорректно при применении промокода 'SUMMER10'[API /v1/users] Запрос POST возвращает 500 Internal Server Error при отправке пустого тела[Моб. приложение, iOS] Краш при переходе из раздела 'Профиль' в 'Настройки' на устройстве с iOS 16
Плохие примеры и почему:
Не работает— Слишком общий. Что именно?Ошибка в кнопке— Неинформативно. Какая ошибка и где?Сервер упал— Субъективно и неточно. Может быть, просто ошибка 5xx.Баг в логике, нужно пофиксить— Содержит предположение и указание к действию. Задача заголовка — описать проблему, а не ее решение.
Правильный заголовок экономит время всей команды на поиск, понимание и классификацию дефекта.