Баг-репорти, які люблять розробники: шаблон і реальні приклади
Хороший баг-репорт виправляють швидше. Ось наш шаблон, приклад поганого й хорошого репорту і те, як ми визначаємо серйозність і пріоритет.
Баг, який неможливо відтворити, не виправляють. Баг-репорт, на розуміння якого розробник витрачає двадцять хвилин, відкладають. Якість баг-репортів напряму впливає на швидкість команди, тому ми вважаємо їх написання ключовою навичкою QA, а не бюрократією.
Анатомія хорошого репорту
| Поле | Що писати |
|---|---|
| Заголовок | Що зламано, де і за якої умови. Коротко й так, щоб легко знайти пошуком |
| Оточення | Збірка/версія, URL, пристрій, ОС, браузер, тип акаунта |
| Передумови | Дані чи стан, потрібні до кроку 1 |
| Кроки відтворення | Нумеровані, мінімальні, одна дія на крок |
| Очікуваний результат | Що має відбутися, бажано з посиланням на вимогу |
| Фактичний результат | Що відбувається натомість, включно з текстом помилки |
| Докази | Скриншот, відео, логи, мережевий запит (HAR), помилки в консолі |
| Серйозність / Пріоритет | Вплив на продукт / терміновість виправлення |
| Частота | Завжди, іноді (3 з 10), один раз |
Поганий і хороший
Поганий репорт:
Той самий баг, описаний добре:
Заголовок: Оформлення – кнопка «Оплатити» залишається неактивною після застосування промокоду в мобільному Safari
Оточення: staging build 1.4.2 (#1287), iPhone 13, iOS 17.5, Safari
Акаунт: зареєстрований користувач test.buyer+12@…, кошик із 2 товарів ($64.00)
Кроки:
1. Відкрити /cart
2. Ввести промокод SPRING10 і натиснути «Застосувати»
3. Натиснути «Оформити» й заповнити коректну адресу
4. Обрати «Картка» як спосіб оплати
Очікувано: кнопка «Оплатити $57.60» активна
Фактично: кнопка неактивна; в консолі
TypeError: total.toFixed is not a function (checkout.js:214)
Частота: 5/5 в iOS Safari; не відтворюється в Chrome на десктопі
Докази: video.mp4, console.log, HAR-файл додано
Серйозність: Critical (користувачі не можуть оплатити) Пріоритет: High
Другу версію можна виправити без жодного уточнювального питання. Помилка в консолі навіть вказує розробнику на рядок коду.
Серйозність і пріоритет
Серйозність описує вплив дефекту на систему. Пріоритет — як швидко його треба виправити. Зазвичай вони пов'язані, але не завжди, і ця різниця важлива при плануванні.
Наш чекліст перед натисканням «Створити»
- Відтворено щонайменше двічі, бажано в чистій сесії
- Перевірено, чи немає дубліката
- Кроки мінімальні: прибрано все, що не потрібне для відтворення
- Один баг — один репорт
- Заголовок зрозумілий без відкриття тікета
- Докази додано, чутливі дані приховано
- Без емоцій і звинувачень, лише факти
Після репорту
Коли баг виправлено, QA перевіряє виправлення в тому самому оточенні й робить коротку регресію довкола. Для багів, що повторюються, ми проводимо аналіз першопричин: чому це сталося і який тест, рев'ю чи перевірка зловили б це раніше? Саме це питання допомагає командам не бачити той самий тип бага двічі.