Один дефект в одном отчёте
Один отчёт посвятите одному воспроизводимому дефекту. Укажите окружение, вход, шаги, ожидаемое и наблюдаемое поведение. Если это только предложенный сценарий, не называйте наблюдение результатом настоящего запуска.
Учебный пример: импорт CSV с одной записью и пустой строкой в конце. Ожидаемое число записей равно одному, условно показанное ошибочное число равно двум. Программа здесь не выполнялась; значения заданы автором для упражнения по оформлению отчёта.
Образец с конкретным входом
Рабочая запись может быть такой: «Вход: CSV с заголовком, одной строкой данных и пустой строкой в конце. Шаги: открыть импорт, выбрать файл, выполнить импорт. Ожидается одна запись. В учебном сценарии результат обозначен как две записи».
Не добавляйте настоящую версию, операционную систему и сообщение ошибки из памяти. В реальном отчёте их нужно получить при воспроизведении. Если есть скриншот, свяжите его с конкретным запуском, а не с похожей ситуацией.
Сохраните минимальный файл без персональных данных, чтобы другой человек мог проверить тот же вход.
Что проверить перед отправкой
Перед отправкой проверьте, хватает ли сведений для повторения и не смешаны ли разные ошибки. Разность условных чисел равна одной лишней записи, но из неё не следует причина ошибки в коде.
Предположение о подсчёте пустой строки обозначьте как гипотезу до проверки. Не пишите «нужно удалить функцию», если вы не исследовали реализацию. Для первичного отчёта важнее точный вход и результат.
После реального запуска добавьте фактический статус: воспроизведено, не воспроизведено или не проверялось. Сохраните дату и окружение. Учебный образец помогает оформить сообщение, но не подтверждает наличие дефекта в каком-либо продукте.