Bug submission manual · Как правильно сообщить об ошибке · Submit Bug Report
-
Read the list of the current issues. Avoiding duplications is a very important goal, so please pay attention to what is already there. If you see the report, which is close, but not exactly what you want to report - good practice is to contact the author and confirm. It's better to add something to the existing report rather than create a new one.
-
Fill in the Title: please be short, descriptive, and informative. The Title is meant to be easily readable by everyone. Correct Title is a great deal to prevent duplications.
-
Fill in the "Write" section. Please remember that no one is expecting you to be perfect since the start, however, there is good practice to look at examples. We recommend you to use the following template:
- Device and serial number
- ExpertSDR3 version, build number, firmware version
- OS: Windows 10/ macOS/ Linux Ubuntu - under which OS you have confirmed the issue
- Your PC parameters briefly
- Description: full and most descriptive information about the bug/issue
- Correlations: indicate if you found any dependencies or conditions under which issue/bug occurs
- Reproduction steps - describe if applicable
-
Please note that adding info to the existing report (as the report progress) is important. If you found new or corrective information - please submit it ASAP. As usual, please keep it short, but as much descriptive as possible.
-
Attach a backtrace.dump file to any report, it's located in the Settings folder. Windows: C:/Users/UserName/AppData/Local/Expert Electronics/ExpertSDR3 Linux: /home/UserName/.config/Expert Electronics/ExpertSDR3 Mac OSX: /Users/UserName/Library/Preferences/Expert Electronics/ExpertSDR3
-
Прочтите список уже зарегистрированных ошибок. Очень важно избегать задвоений, поэтому пожалуйста, будьте внимательны к тому, что уже зарегистрировано. Если вы видите сообщение близкое по смыслу, но отличное в деталях от того, что хотите написать вы - свяжитесь с автором и уточните подробности. Лучше добавить дополнительную информацию в уже существующий отчет об ошибке, чем создавать новый.
-
Заголовок (секция Title): пожалуйста будьте кратки, но информативны. Заголовок должен быть удобен к прочтению кем угодно. Правильный Заголовок очень важен для предотвращения задвоений.
-
Тело отчета (секция Write). Мы понимаем, что сначала вы можете совершать ошибки в оформлении отчета, поэтому рекомендуем смотреть как это делают другие. За основу же можно взять следующий порядок оформления:
- Модель радио и серийный номер
- Версия и номер билда ExpertSDR3, версия прошивки трансивера
- ОС: Windows 10/ macOS/ Linux Ubuntu - используя какую ОС вы столкнулись с ошибкой
- Кратко характеристики вашего ПК
- Описание: максимально полная информация об ошибке
- Условия: укажите условия в которых проявляется ошибка
- Укажите последовательность действий для воспроизведения ошибки, если можете
-
Помните, что Важно добавлять актуальную информацию в отчет об ошибке (по мере её решения). Если Вы обнаружили какую-то уточняющую информацию - пожалуйста сообщите о ней как можно скорее. Как всегда, пожалуйста будьте кратки, но как можно более полно.
-
Всегда прикладывайте файл backtrace.dump регистрируя новую ошибку, он расположен в папке Settings. Windows: C:/Users/UserName/AppData/Local/Expert Electronics/ExpertSDR3 Linux: /home/UserName/.config/Expert Electronics/ExpertSDR3 Mac OSX: /Users/UserName/Library/Preferences/Expert Electronics/ExpertSDR3
