1
0
mirror of https://github.com/f4exb/sdrangel.git synced 2024-11-04 16:01:14 -05:00
sdrangel/IssueTemplate.md
AsynchronousGalaxy 297cc40074 Propose IssueTemplate
I would like to contribute to this project in the form of proposing an Issue Template. Reading the Wiki, I saw a section about how this project is fun when adding new features, and not so much when there are issues that turn out to not be reproducible, or worse, an issue with the hardware setup.

Hoping that this issue template can be added to the project and listed under the "Insights" tab of the community page.

Thank you for all that you have done in this project, I have learned so much!
2021-12-07 16:59:55 -07:00

46 lines
1.9 KiB
Markdown

# SDRangel Issue Template
Please let us know how you use the software, and what you enjoy, or don't enjoy the most.
We are interested to find out how other people make use of this software.
#### From the Project Wiki:
*I ask you (as a User or Collaborator) to take the role of first level support.
It means you have to help me and not the opposite: you have to help me
understand the problem or what you think is a problem*
### Subject or type of issue
* Describe your issue here.
* Is this a runtime or compilation issue?
* If compilation, where in the instructions are you stuck?
### SDR
* We always want to first rule out that there is no issue with your hardware
* Which SDR are you using?
* Which version of Driver do you have loaded for the SDR?
* If applicable, Can you prove SDR functionality with a loopback test?
* Have you tried power cycling the SDR or the machine connecting to the SDR? Sometimes a reset is all you need.
* Perhaps this is the issue, that the issue causes you to need to reset.
### Development environment
* Compilation instructions are given in terms of Ubuntu 21.04, have you tried to recreate the issue using this environment?
* CPU and RAM of your machine if applicable
### Actual behavior
* Tell us what happens.
* Be specific here, It is important that we be able to recreate the issue
* Please list any relevant information leading up to the issue
### Expected behavior
* Tell us what should happen
* Helps us ensure that you understand what you are trying to do so that we can rule out any user error.
### Steps to reproduce
* Tell us how to reproduce this problem. Include screenshots, where applicable
* If radio related, have you tried to reproduce with a different radio, if possible?
* Please list Center Frequency, bandwidth and any other applicable RF settings that are pertinent to the issue.
### Log Files
* Please read any pertinant log files!
* Attach any relevant information you find here.