Ответ
Вложение (Attachment) в баг-репорте — это любой файл, прикрепленный к отчету об ошибке для наглядной демонстрации проблемы или предоставления дополнительной диагностической информации. Это критически важный элемент, который превращает текстовое описание в доказательство.
Цели использования вложений:
- Наглядность: Показать проблему "как есть".
- Сокращение времени на понимание: Разработчику не нужно воспроизводить шаги "вслепую".
- Предоставление контекста: Дать доступ к данным, которые сложно описать текстом.
- Неопровержимое доказательство: Фиксация состояния системы в момент ошибки.
Типичные типы вложений:
- Скриншоты/Скринкасты: Показывают визуальную ошибку, неверное поведение UI, последовательность шагов.
- Логи (Logs): Текстовые файлы с выводами консоли, логами приложения (
logcat), серверными логами. Помогают определить место и причину сбоя в коде. - Видеозаписи (Video): Для демонстрации сложных или непостоянных багов, связанных с анимацией, таймингами или взаимодействием.
- Файлы конфигурации или входных данных: Если баг воспроизводится на конкретном наборе данных.
- Дампы памяти/трассировки стека (Core dumps, Stack traces): Для анализа критических сбоев.
Пример оформления в баг-репорте:
Шаги воспроизведения:
1. Зайти на страницу /checkout.
2. Добавить товар в корзину.
3. Нажать кнопку "Оплатить".
Ожидаемый результат: Открывается форма выбора способа оплаты.
Фактический результат: Появляется белый экран (см. скриншот attachment_1.png).
В логах приложения зафиксирована ошибка NullPointerException (см. logs.txt).Правила хорошего тона:
- Делайте скриншоты целого экрана или окна, а не фрагмента.
- Выделяйте на скриншотах область с проблемой (стрелкой, рамкой).
- Прикладывайте логи, очищенные от лишней информации, с временными метками вокруг момента ошибки.
- Называйте файлы информативно (например,
error_ui_payment_blank.png,logcat_npe_error.txt).