Вложения в отчёте о баге | Bug Report Attachments
Что нужно приложить при отправке отчета о баге?
Каждый баг должен быть задокументирован, по крайней мере, одним вложением. В приложении вы указываете, что баг возникает на вашем устройстве, операционной системе и/или браузере. Примечание: Приложения НЕ заменяют письменную информацию, содержащуюся в вашем отчете. Вложения представляют собой наглядное представление проблемы и служат доказательством.
Скриншот или скринкаст?
В целом, большинство функциональных багов требуют надлежащего и эффективного отображения на экране. Если только инструкции или руководитель группы не попросит предоставить конкретные вложения, используйте следующее практическое правило, чтобы определить, требуется ли вам скриншот или скринкаст для просмотра сообщения о баге:
• Всякий раз, когда требуется действие для запуска бага или когда процесс должен быть проиллюстрирован, загружайте скринкаст. Снимки экрана в виде статичных изображений являются снимками и не могут иллюстрировать первопричину.
• Когда природа бага статична, например, при статических проблемах с графическим интерфейсом пользователя, для вложений достаточно скриншота.
Общие требования к приложению
• Для каждого сообщения о баге или его воспроизведения необходимо создавать новые вложения.
• Запрещается копировать вложения из других сообщений о багах или их воспроизведение.
• В качестве доказательства в приложениях должна быть приведена вся необходимая информация о баге.
• Вся соответствующая информация должна отображаться на английском языке (или на немецком, если языком сообщения о багн является немецкий), например, дата, системная информация и сообщения о баге.
• Запрещается изменять содержимое веб-сайта, например, с помощью службы Google Translator для перевода веб-сайта на другой язык, поскольку это может привести к неожиданному поведению.
• Не показывайте никакой информации о других клиентах (например, электронные письма с приглашениями или названия вкладок браузера с указанием названия компании).
• Если вы используете несколько браузеров или устройств, загрузите вложения для каждого из них.
• Для тестирования веб-сайта поле URL-адреса должно быть видно на вложениях.
• Текущая дата должна быть видна на вложениях.
• Дата может быть в любом распространенном формате даты, например, DD/MM или MM/DD.
• Разрешение должно быть достаточно высоким, чтобы текст и элементы можно было легко определить.
• Записываемая часть экрана должна быть достаточно большой для ориентации.
• Максимальный размер файла для вложений - 25 МБ.
• В случае возникновения багов в сообщениях о багах приложений обязательно должен быть создан журнал ошибок (crush log). Видеозапись бага должна соответствовать прилагаемому журналу ошибок, т.е. должны быть согласованными по времени.
Отображение текущей даты
Отображая текущую дату в приложении, вы доказываете, что записали ее в этот день. В приведенном ниже списке указано, где найти дату:
- Windows: Отображение панели задач или слияние в календаре
- Mac: Отображение значка календаря
- iOS & Android: Проведите вниз по центру уведомлений в начале записи.
Что необходимо включить в скриншот?
Правила, характерные для скриншотов:
• Снимок экрана должен быть в формате JPG или PNG.
• Выделите баг на снимке экрана.
• При доказательстве бага с помощью скриншота на мобильном устройстве должен быть загружен второй скриншот с указанием даты (заряд батареи и время должны совпадать с первым скриншотом).
Что необходимо включить в скринкаст?
Записи должны быть как можно более короткими, но настолько длинными, насколько это необходимо. Это означает, что вы должны пропустить шаги, которые не вызывают баг. Например, когда кнопка "Добавить в корзину" на странице информации о товаре в интернет-магазине неисправна, обычно не имеет значения, как вы перемещались по интернет-магазину, чтобы попасть на страницу информации о товаре.
Важным обычно является последний навигационный шаг, шаг, который запускает баг.
Пример 1: Баг на веб-сайте, протестирована на настольном устройстве.
Шаги для создания скринкаста:
1. Перейдите на страницу, где происходит баг.
2. Начинайте запись.
3. Обновите страницу.
4. Выполните действие, вызывающее баг.
5. Дождитесь появления бага.
6. Остановите запись.
Пример 2: Баг в приложении, протестировано на мобильном устройстве.
Шаги для создания скринкаста:
1. Запустите приложение и перейдите на страницу, где требуется только еще один этап для перехода на страницу, где произошёл баг.
2. Начинайте запись.
3. Проведите вниз по центру уведомлений, чтобы отобразить текущую дату в течение нескольких секунд.
4. Выполните последний шаг для перехода к нужной странице.
5. Выполните действие, вызывающее баг.
6. Дождитесь появления бага.
7. Останови запись.
Руководители групп могут отправить вам информационный запрос с просьбой о проведении внешней или дополнительной записи. Это делается для того, чтобы лучше понять багили в случае сомнений из-за того, что он не может быть воспроизведен.
Правила, характерные для скринкаста:
• Экран должен иметь формат MP4-файла.
• Максимальное время для скринкаста составляет 60 секунд, если только ваш баг не требует отображения процесса загрузки или длительных необходимых ручных вводов.
• Щелчки/нажатия/касания должны быть видны (требуется только для записей на Android и настольных компьютерах).
• Сделай запись за один раз. Не останавливайте запись посередине.
• Не вырезайте части результирующего скринкастата посередине. При необходимости обрезайте только начало или конец файла.
• Частота кадров должна быть достаточно высокой, чтобы идентифицировать ваши действия и проанализировать ход событий.
• Звук не записывается, если не указано иное.