ExpertSDR3 / ExpertSDR3-BUG-TRACKER

19 stars 13 forks source link

ExpertSDR3 Bug Tracker

Welcome to Expert Electronics software bug tracker

Bug submission manual · Как правильно сообщить об ошибке · Submit Bug Report

Bug submission Manual EN

  1. 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.

  2. 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.

  3. 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:

  1. 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.

  2. 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

Bug submission Manual RU

  1. Прочтите список уже зарегистрированных ошибок. Очень важно избегать задвоений, поэтому пожалуйста, будьте внимательны к тому, что уже зарегистрировано. Если вы видите сообщение близкое по смыслу, но отличное в деталях от того, что хотите написать вы - свяжитесь с автором и уточните подробности. Лучше добавить дополнительную информацию в уже существующий отчет об ошибке, чем создавать новый.

  2. Заголовок (секция Title): пожалуйста будьте кратки, но информативны. Заголовок должен быть удобен к прочтению кем угодно. Правильный Заголовок очень важен для предотвращения задвоений.

  3. Тело отчета (секция Write). Мы понимаем, что сначала вы можете совершать ошибки в оформлении отчета, поэтому рекомендуем смотреть как это делают другие. За основу же можно взять следующий порядок оформления:

  1. Помните, что Важно добавлять актуальную информацию в отчет об ошибке (по мере её решения). Если Вы обнаружили какую-то уточняющую информацию - пожалуйста сообщите о ней как можно скорее. Как всегда, пожалуйста будьте кратки, но как можно более полно.

  2. Всегда прикладывайте файл 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

    VS Code in action

Контакты Contacts