При написании отчета об ошибке, пожалуйста, включите краткое соответствующее название.
В названии должно быть указано, каким должно быть ожидаемое поведение. Хотя полезно описать то, что нарушено, этот подход чреват двумя опасностями. Во-первых, пожалуйста, включите достаточную информацию, а не просто, например, «таблица сломана». Во-вторых, пожалуйста, скажите, каково ожидаемое правильное поведение, а не что нарушено. Например, если вы скажете «стол не должен сортировать по дате», то инженеру, который его починит, придется потратить дополнительные усилия, чтобы выяснить, как он должен себя вести: должен ли он сортировать по имени, восходя? Должен ли он сортироваться по id, нисходящему? Даже когда ошибка явно очевидна, правильное исправление обычно должно быть описано независимо от проблемы. Поэтому лучше всего использовать заголовок, чтобы кратко и уместно описать, что функциональность должна быть, а не как именно она нарушена.
Важно отметить, что каждый отчет об ошибках должен состоять из трех частей: шаги по воспроизведению, ожидаемый результат, фактический результат.
### Шаги для воспроизведения:
Например.
* Логин стандартного пользователя
* откройте SearchModal, напишите «любой» в поле имен, нажмите «бегать»
* Откройте QueriesModal, нажмите, чтобы изменить запрос
Нажмите «Сохранить», чтобы закончить изменение
### Ожидаемый результат:
Например.
Результаты должны быть пустыми, а в заголовке результатов должно быть написано «нет результатов».
###Реальный результат:
Например.
Таблица результатов не изменилась и по-прежнему показывает некоторое количество результатов предыдущего поиска.
Следует отметить, что не вся вышеупомянутая информация на самом деле актуальна и необходима для каждого сообщения об ошибках, но очень полезно думать об этих трех частях по мере необходимости. Недостающая информация неизбежно приведет к дальнейшим вопросам от инженеров - так что это экономит время, чтобы добавить эту информацию с самого начала.
Важно отметить, что на скриншотах, пожалуйста, включите URL каждой страницы, на каждом скриншоте. URL часто очень, очень важен, и просто наличие скриншота страницы, без URL, часто не дает достаточной информации для устранения проблемы.
