Перейти к содержимому

Шаблон баг-репорта: бесплатно, для Jira, GitHub и Linear

Бесплатный шаблон баг-репорта для копирования, готовые версии для GitHub, Linear и Jira, форма задачи GitHub и заполненный пример.

Шаблон баг-репорта — это фиксированный набор полей, благодаря которому каждый репорт отвечает на одни и те же вопросы: что сломалось, где, как это воспроизвести, что должно было произойти и какие улики это подтверждают. Шаблон ниже включает заголовок, краткое описание, окружение, шаги воспроизведения, ожидаемый и фактический результат, частоту, серьёзность, вложения и логи. Скопируйте его в трекер задач, форму поддержки или сообщение в чате и заполните пропуски. Ниже есть готовые версии для GitHub, Linear и Jira, включая форму задачи GitHub.

Шаблоны нужны потому, что разработчики теряют больше всего времени на недостающих деталях, а не на самом исправлении. Репорт с точными шагами, версией браузера и ошибкой консоли часто удаётся закрыть в тот же день. Репорт со словами «оформление заказа сломалось» превращается в длинную ветку вопросов.

Шаблон

Заголовок: [Что сломалось] при [действие] на [страница или функция]

Краткое описание
Одно-два предложения простым языком. Что произошло и кого это затрагивает.

Окружение
- URL:
- Браузер и версия:
- Операционная система:
- Устройство / размер экрана:
- Версия или сборка приложения (если известна):
- Аккаунт / роль / тестовый пользователь:
- Дата и время, когда это произошло (с часовым поясом):

Шаги воспроизведения
1.
2.
3.

Ожидаемый результат
Что должно было произойти.

Фактический результат
Что произошло вместо этого. Приведите точное сообщение об ошибке, скопированное текстом.

Частота
Всегда / Иногда (примерно X из Y попыток) / Случилось один раз

Серьёзность
Блокирующий / Значительный / Незначительный / Косметический

Обходной путь
Любой способ обойти проблему или «Не найден».

Вложения
- Скриншот или запись экрана:
- Ошибки консоли:
- Упавший сетевой запрос (URL, статус, ответ):
- HAR файл (очищенный), если просили:

Заметки
Всё остальное: когда это началось, что недавно менялось, связанные тикеты.

Как заполнять каждое поле

Заголовок

Заголовок — это то, что люди пробегают глазами в списке из пятидесяти тикетов, поэтому он должен быть конкретным. Удобная схема: «что сломалось» плюс «когда» плюс «где». «Кнопка оплаты остаётся неактивной после ввода корректной карты при оформлении заказа» лучше, чем «Баг в оформлении заказа». Избегайте слов вроде «срочно» или «сломано» самих по себе: для этого есть поле серьёзности.

Краткое описание

Одно-два предложения, понятные коллеге без технического бэкграунда. Укажите, кого это затрагивает, если знаете: всех пользователей, только админов, только пользователей Safari, только одного клиента.

Окружение

Многие баги зависят от браузера, устройства, аккаунта или данных. Запишите точный URL, название и версию браузера, операционную систему и аккаунт или роль, под которыми работали. Если приложение показывает номер версии или сборки, добавьте его. Время сбоя с вашим часовым поясом позволит разработчику найти соответствующие записи в серверных логах.

Шаги воспроизведения

Это самое важное поле. Пронумеруйте шаги, начните с известного состояния («вошёл как пользователь с пустой корзиной») и укажите точные данные, которые использовали. Один шаг — одно действие. Если повторить баг во второй раз не получилось, так и напишите и как можно точнее опишите, что делали в первый раз.

Ожидаемый и фактический результат

Держите их рядом, чтобы разница сразу бросалась в глаза. Копируйте сообщения об ошибках текстом, а не пересказывайте их: разработчик будет искать в коде именно эту строку. «Ничего не происходит» — допустимый фактический результат, но добавьте, что вы проверили, например «сообщения об ошибке нет, кнопка остаётся активной».

Частота

Баги, которые воспроизводятся «всегда», исправить проще всего. Баги, которые случаются «иногда», требуют больше данных, поэтому оцените частоту («3 из 10 попыток») и отметьте всё, что кажется важным, например медленное соединение или большой файл.

Серьёзность

Серьёзность — это про влияние, а не про то, насколько вас это раздражает. Распространённая шкала:

СерьёзностьЗначениеПример
БлокирующийОсновной сценарий невозможен, обходного пути нетНикто не может войти
ЗначительныйВажная функция сломана или данные неверны, обход мучительныйВ счетах неправильная итоговая сумма
НезначительныйФункция работает, но с мелкой проблемой или простым обходомСортировка сбрасывается после перезагрузки страницы
КосметическийВизуальная проблема без влияния на функциональностьТекст на кнопке перекрывается на маленьких экранах

Приоритет, который определяет, когда баг исправят, обычно ставит команда, владеющая бэклогом, а не автор репорта.

Обходной путь

Обходной путь подсказывает команде, насколько срочно нужно исправление, и помогает поддержке тем временем отвечать клиентам.

Вложения и логи

Больше всего времени экономят улики. Приложите скриншот с отмеченной проблемной областью или короткую запись экрана, где видны шаги. Для веб-приложений добавьте ошибки консоли и упавший сетевой запрос. Как это сделать, показывают наши гайды о том, как сохранить логи консоли в Chrome и как записать сетевой трафик в Chrome. Если вас просят прислать HAR файл, следуйте инструкции как получить HAR файл и сначала очистите его через очистку HAR, потому что HAR файлы содержат cookies и токены.

Заполненный пример

Заголовок: Кнопка «Оплатить» остаётся неактивной после ввода корректной карты при оформлении заказа

Краткое описание
На странице оформления заказа кнопка «Оплатить» так и не становится активной
после ввода корректной тестовой карты, поэтому заказ оформить нельзя. Замечено в Chrome и Edge.

Окружение
- URL: https://staging.example.com/checkout
- Браузер и версия: Chrome 154 на Windows 11; также Edge 154
- Устройство / размер экрана: ноутбук, 1920x1080
- Версия или сборка приложения: web 4.18.0 (в футере)
- Аккаунт / роль / тестовый пользователь: [email protected], обычный клиент
- Дата и время: 2026-11-10 14:32 CET

Шаги воспроизведения
1. Войти как [email protected].
2. Добавить в корзину «Тариф Starter, годовой».
3. Перейти на /checkout.
4. Ввести тестовую карту 4242 4242 4242 4242, срок 12/30, CVC 123.
5. Кликнуть за пределами поля карты.

Ожидаемый результат
Кнопка «Оплатить» становится активной и показывает «Оплатить $120.00».

Фактический результат
Кнопка «Оплатить» остаётся серой и неактивной. Сообщения об ошибке нет.
В консоли: Uncaught TypeError: Cannot read properties of
undefined (reading 'postalCode') at validateCard (checkout.js:214)

Частота
Всегда (5 из 5 попыток)

Серьёзность
Блокирующий: клиенты не могут оплатить

Обходной путь
Не найден. На продакшен-сборке 4.17.2 работает.

Вложения
- Запись экрана: ссылка в комментариях
- Ошибки консоли: checkout-console.log
- Сеть: POST /api/cart/validate вернул 200; других сбоев нет

Заметки
Началось после сегодняшнего утреннего деплоя на staging.

Обратите внимание, за счёт чего этот пример работает. Шаги начинаются с известного аккаунта. Тестовая карта указана явно. Ошибка консоли процитирована дословно. Автор проверил другой браузер и предыдущую сборку, а это уже сужает причину до последнего изменения.

Короткие версии

Не каждому багу нужны все поля. Для быстрого сообщения в командном чате хватит компактной версии:

Баг: [заголовок]
Где: [URL], [браузер/ОС]
Шаги: 1) ... 2) ... 3) ...
Ожидалось: ...
Фактически: ...
Улики: [скриншот / запись / ошибка консоли]

Командам поддержки, которые пересылают репорт пользователя, стоит добавить ID аккаунта клиента, ссылку на тикет и слова самого клиента, а также отметить, какие части вы воспроизвели сами.

Для тестовых прогонов QA добавьте ID тест-кейса и тестируемую сборку, чтобы баг был связан с тестом, который его нашёл.

Шаблоны для GitHub, Linear и Jira

Текстовый шаблон работает где угодно. Если ваш трекер отображает Markdown, эта версия сохраняет заголовки и чек-листы читаемыми:

## Краткое описание
<!-- Одно-два предложения: что произошло и кого это затрагивает. -->

## Окружение
- URL:
- Браузер и версия:
- Операционная система:
- Версия или сборка приложения:
- Аккаунт / роль:

## Шаги воспроизведения
1.
2.
3.

## Ожидаемый результат

## Фактический результат
<!-- Приведите точное сообщение об ошибке текстом. -->

## Частота
<!-- Всегда / Иногда (X из Y) / Один раз -->

## Серьёзность
<!-- Блокирующий / Значительный / Незначительный / Косметический -->

## Улики
- [ ] Скриншот или запись экрана
- [ ] Ошибки консоли
- [ ] Упавший сетевой запрос

GitHub Issues

Сохраните Markdown-версию в репозитории как .github/ISSUE_TEMPLATE/bug_report.md с коротким заголовком, чтобы GitHub предлагал её при создании задачи (кнопка «New issue»):

---
name: Баг-репорт
about: Что-то сломалось
labels: bug
---

GitHub также поддерживает формы задач (issue forms): они превращают шаблон в поля с подписями, которые нельзя пропустить. Сохраните это как .github/ISSUE_TEMPLATE/bug_report.yml:

name: Баг-репорт
description: Что-то сломалось
labels: ["bug"]
body:
  - type: textarea
    id: summary
    attributes:
      label: Краткое описание
      description: Что произошло и кого это затрагивает?
    validations:
      required: true
  - type: input
    id: url
    attributes:
      label: URL
  - type: input
    id: environment
    attributes:
      label: Браузер, ОС и версия приложения
      placeholder: Chrome 154 на macOS 26, web 4.18.0
  - type: textarea
    id: steps
    attributes:
      label: Шаги воспроизведения
      value: |
        1.
        2.
        3.
    validations:
      required: true
  - type: textarea
    id: expected
    attributes:
      label: Ожидаемый результат
    validations:
      required: true
  - type: textarea
    id: actual
    attributes:
      label: Фактический результат
      description: Приведите точное сообщение об ошибке текстом.
    validations:
      required: true
  - type: dropdown
    id: severity
    attributes:
      label: Серьёзность
      options:
        - Блокирующий
        - Значительный
        - Незначительный
        - Косметический
  - type: textarea
    id: evidence
    attributes:
      label: Скриншоты, запись и логи
      description: Перетащите сюда файлы или вставьте ссылку на запись.

Linear

В Linear шаблоны задач находятся в настройках команды. Создайте шаблон с названием «Bug», вставьте Markdown-версию в его описание и укажите метку Bug и статус триажа команды, чтобы каждый репорт начинался с одних и тех же полей.

Jira

В Jira вставьте текстовую или Markdown-версию в описание нового бага (Bug). В Jira Cloud нет встроенного описания по умолчанию для каждого типа задачи, поэтому команды, которым нужен заранее заполненный шаблон, используют приложение для шаблонов задач из Atlassian Marketplace. Ссылку на запись экрана с логами консоли и сети добавьте в описание или комментарий.

Ошибки, от которых защищает шаблон

По сути шаблон — это чек-лист против одних и тех же нескольких ошибок:

  • Несколько багов в одном репорте. Один тикет на одну проблему, чтобы каждую можно было исправить, проверить и закрыть отдельно.
  • Пересказанные ошибки. «Там было что-то про права доступа» не найти поиском. Точное сообщение — найти.
  • Нет отправной точки. Шаги, которые начинаются с середины сценария, работают только у того, кто их писал.
  • Мнения вместо наблюдений. «API сломан» — это догадка. «POST /api/orders вернул 500» — факт, который разработчик может проверить.
  • Секреты во вложениях. Скриншоты админок, HAR файлы и логи консоли могут содержать токены и данные клиентов. Обрежьте, размойте или очистите их перед отправкой.

Сделайте шаблон стандартом команды

Большинство трекеров задач позволяют сохранить описание или шаблон задачи по умолчанию, чтобы каждый новый баг начинался с этих заголовков. Держите шаблон достаточно коротким, чтобы его действительно заполняли. Если поле пустует в большинстве репортов, уберите его. Если разработчики снова и снова задают один и тот же уточняющий вопрос, добавьте для него поле.

Пусть технические поля заполняет инструмент

Чаще всего пропускают как раз технические поля: версию браузера, ошибки консоли, упавший запрос. Midge, бесплатное расширение для Chrome, автоматически прикладывает их к записи экрана или скриншоту, так что автору остаётся написать только заголовок, шаги и ожидаемый результат. В каждой записи есть логи консоли, сетевые запросы, действия пользователя и данные об устройстве. Пароли, номера карт, токены и cookies удаляются прямо в браузере, прежде чем что-либо покинет ваше устройство. Репорт уходит прямо в Jira, Linear, GitHub Issues или Slack либо отправляется ссылкой, которую можно вставить куда угодно.

Похожие гайды

Частые вопросы

Что должно быть в шаблоне баг-репорта?

Понятный заголовок, окружение (URL, браузер, ОС, версия приложения, аккаунт), пронумерованные шаги воспроизведения, ожидаемый результат, фактический результат, как часто это происходит, серьёзность и улики: скриншоты, видео, логи консоли и сетевые запросы.

Можно ли использовать этот шаблон в Jira, Linear или GitHub Issues?

Да. Это обычный текст с заголовками, совместимыми с Markdown, поэтому его можно вставить в любой трекер. В GitHub и Linear его также можно сохранить как шаблон задачи, а в Jira — с помощью приложения из Marketplace.

Где хранятся шаблоны задач GitHub?

В папке .github/ISSUE_TEMPLATE репозитория. Файл .md добавляет Markdown-шаблон, а файл .yml — форму задачи с обязательными полями. GitHub показывает их, когда кто-то создаёт новую задачу.

Чем серьёзность отличается от приоритета?

Серьёзность описывает, насколько сильно баг влияет на продукт или пользователей. Приоритет описывает, как скоро команда его исправит. Серьёзный баг в редко используемом экране админки может иметь более низкий приоритет, чем косметический баг на странице с ценами.

Нужно ли заполнять все поля?

Нет. Заголовок, шаги, ожидаемый и фактический результат обязательны. Остальное заполняйте, когда знаете, а если не знаете, так и пишите «неизвестно», а не гадайте.