Сообщая поставщикам браузеров о проблемах, которые вы обнаружили в их браузере, является неотъемлемой частью улучшения веб-платформы.
Чтобы составить хорошее сообщение об ошибке, нужно немного поработать. Ваша цель – максимально упростить для разработчиков браузера поиск ошибок, их причин и, самое главное, способов их устранения. Ошибки, которые быстро исправляются, как правило, легко воспроизвести, и у них есть четкое ожидаемое поведение.
Убедитесь, что это ошибка
Сначала нужно определить, как должен работать код.
Как должен работать продукт?
Ознакомьтесь с документацией по API на сайте MDN или найдите связанные спецификации. Эта информация поможет вам определить, какой API не работает, где именно и как он должен работать.
Работает ли он в другом браузере?
Поведение, которое различается в разных браузерах, обычно имеет более высокий приоритет как проблема совместимости, особенно когда браузер, содержащий ошибку, является странным. Протестируйте сайт в последних версиях Chrome, Firefox, Safari и Edge. Для этого можно использовать такой инструмент, как BrowserStack.
По возможности убедитесь, что страница не ведет себя иначе из-за определения агента пользователя. В инструментах разработчика Chrome попробуйте задать для строки User-Agent другой браузер.
Проблема возникла в недавнем выпуске?
Работала ли эта функция как ожидалось в прошлом, но перестала работать в недавнем выпуске браузера? Такие регрессии можно устранить гораздо быстрее, особенно если вы укажете номер версии, в которой все работало, и номер версии, в которой произошел сбой. Для проверки старых версий браузеров можно использовать такие инструменты, как BrowserStack. Чтобы найти изменение, используйте такие инструменты, как bisect-builds (для Chromium).
Если проблема является регрессией и ее можно воспроизвести, то обычно основную причину можно найти и устранить быстро.
Возникает ли эта проблема у других пользователей?
Если у вас возникли проблемы, скорее всего, с ними столкнулись и другие разработчики. Сначала попробуйте найти ошибку на сайте Stack Overflow. Это поможет вам понять, какой именно API работает неправильно, и найти временное решение, пока ошибка не будет исправлена.
Сообщалось ли о ней ранее?
Когда вы поймете, в чем заключается ошибка, проверьте, не сообщал ли о ней кто-то до вас. Для этого выполните поиск в базе данных ошибок браузера.
- Браузеры на основе Chromium: https://crbug.com.
- Firefox: https://bugzilla.mozilla.org/
- Safari и браузеры на основе WebKit: https://bugs.webkit.org/.
Если вы найдете описание проблемы, с которой столкнулись, добавьте свой голос, пометив ее звездочкой, добавив в избранное или оставив комментарий. На многих сайтах вы можете добавить себя в список получателей копий и получать уведомления об изменениях в ошибке.
Если вы решите оставить комментарий, укажите, как ошибка влияет на ваш сайт. Не добавляйте комментарии в стиле "+1", так как трекеры ошибок обычно отправляют электронные письма для каждого комментария.
Сообщить об ошибке
Если вы не нашли нужной информации, сообщите об ошибке разработчику браузера.
Создайте минимальный тестовый пример
В статье Mozilla рассказывается, как создать минимальный тестовый пример. Короче говоря, хотя описание проблемы – это отличное начало, нет ничего лучше, чем предоставить ссылку на демоверсию, в которой показана проблема. Чтобы ускорить процесс, пример должен содержать минимально возможный код, необходимый для демонстрации проблемы. Предоставление минимального примера кода – это самое важное, что вы можете сделать, чтобы повысить вероятность исправления ошибки.
Вот несколько советов по минимизации тестового примера:
- Скачайте веб-страницу, добавьте
<base href="https://original.url">и проверьте, воспроизводится ли ошибка локально. Если в URL используется протокол HTTPS, может потребоваться работающий HTTPS-сервер. - Протестируйте локальные файлы в последних сборках как можно большего количества браузеров.
- Постарайтесь объединить все данные в одном файле.
- Удаляйте код (начиная с того, что точно не нужно), пока ошибка не исчезнет.
- Используйте управление версиями, чтобы сохранять свою работу и отменять действия, которые пошли не так.
Разместите тестовый пример в минифицированном виде
Если вы ищете, где разместить минифицированный тестовый пример, то можете воспользоваться одним из следующих сервисов:
Учтите, что на некоторых из этих сайтов контент показывается в окне iframe, из-за чего функции могут работать по-разному, а ошибки – проявляться по-разному.
Сообщить о проблеме
После того как вы создали минимальный тестовый пример, вы можете сообщить об ошибке. Перейдите на нужный сайт для отслеживания ошибок и создайте новую проблему.
- Браузеры на основе Chromium – https://crbug.com/new.
- Firefox – https://bugzilla.mozilla.org/
- Safari и браузеры на основе WebKit – https://bugs.webkit.org/.
Добавьте понятные описания и шаги для воспроизведения
Сначала предоставьте четкое описание, чтобы помочь инженерам быстро понять, в чем заключается проблема, и помочь в ее сортировке.
When installing a PWA using the `beforeinstallprompt.prompt()`, the
`appinstalled` event fires before the call to `prompt()` resolves.
Затем подробно опишите шаги, необходимые для воспроизведения проблемы, а также ожидаемый и фактический результаты.
What is the expected result? In the console:
0. INSTALL: Available (logged when `beforeinstallprompt` event fired)
1. INSTALL_PROMPT_RESPONSE: {outcome: "accepted", platform: "web"}
(logged when beforeinstallprompt.prompt()` resolves)
2. INSTALL: Success (logged when `appinstalled` event fired)
What is the actual result? In the console:
0. INSTALL: Available (logged when `beforeinstallprompt` event fired)
1. INSTALL: Success (logged when `appinstalled` event fired)
2. INSTALL_PROMPT_RESPONSE: {outcome: "accepted", platform: "web"}
(logged when beforeinstallprompt.prompt()` resolves)
Дополнительную информацию можно найти в руководстве по составлению отчетов об ошибках на сайте MDN.
Дополнительно: добавьте скриншот или запись экрана с проблемой
При желании вы можете добавить скриншот или скринкаст, на котором видна проблема. Это особенно полезно, когда ошибки возникают после нескольких шагов или необычных действий. Записи экрана и скриншоты часто помогают разработчикам браузеров лучше понять, что произошло.
Добавьте детали окружения.
Некоторые ошибки воспроизводятся только в определенных операционных системах или на определенных типах дисплеев (например, с низким или высоким разрешением). Обязательно укажите сведения обо всех тестовых средах, которые вы использовали.
Отправьте отчет об ошибке
Отправьте отчет. Следите за электронной почтой, чтобы не пропустить ответы на сообщение об ошибке. Обычно в ходе расследования у инженеров возникают дополнительные вопросы. Если у них возникнут трудности с воспроизведением проблемы, они могут связаться с вами.