diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 00000000..e06d7c53 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,38 @@ +name: Bug Report +description: Submit a bug report +title: "[Bug Report]: " +labels: ["bug report"] +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to fill out this bug report! + - type: dropdown + id: issue type + attributes: + label: What type of issue is this? + options: + - transient - occurring only once + - intermittent - occurring irregularly + - permanent - occurring repeatedly + validations: + required: true + - type: textarea + id: issue + attributes: + label: What issue are you facing? + placeholder: Please describe what you have encountered + validations: + required: true + - type: textarea + id: reproduce issue + attributes: + label: What are the steps to reproduce this? + placeholder: Please provide the steps to reproduce this issue + validations: + required: true + - type: textarea + id: logs + attributes: + label: Can you provide any logs? (output, errors, etc.) + placeholder: Please provide any logs you might have that illustrate the issue diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..ec4bb386 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 00000000..945d8aeb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,17 @@ +name: Feature Request +description: File a feature request +title: "[Feature Request]: " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to fill out this feature request form! + - type: textarea + id: feature request + attributes: + label: What feature would you like to see and why? + description: Please be as detailed as possible with your feature request. + validations: + required: true + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 00000000..e344db6c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,15 @@ +name: Question +description: Ask a question not covered by current hackrf.rtfd.io documentation +title: "[Question]: " +labels: ["question"] +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to ask your question! If you need technical support, want to open a feature request, or need to file a bug report, please abandon this issue, open a new issue, and choose the correct template. If you do not choose the correct template, you will be asked to re-open your issue with the correct template. + - type: textarea + id: question + attributes: + label: What would you like to know? + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/technical-support.md b/.github/ISSUE_TEMPLATE/technical-support.md new file mode 100644 index 00000000..1e2e6d55 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/technical-support.md @@ -0,0 +1,77 @@ +name: Technical Support Request +description: File a technical support request +title: "[Tech Support]: " +labels: ["technical support"] +assignees: + - straithe +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to fill out this technical support request form! Please note that technical support requests can expect a response time of two weeks. + - type: dropdown + id: troubleshooting documentation + attributes: + label: Have you read the HackRF [troubleshooting documentation](https://hackrf.readthedocs.io/en/latest/troubleshooting.html)? + options: + - yes + - no + validations: + required: true + - type: textarea + id: expected outcome + attributes: + label: What outcome were you hoping for? + placeholder: Please be detailed in what you expected to happen + validations: + required: true + - type: textarea + id: actual outcome + attributes: + label: What outcome actually happened? + placeholder: Please be detailed in what did happen + validations: + required: true + - type: checkboxes + id: operating systems + attributes: + label: What operating systems are you seeing the problem on? + multiple: true + options: + - Linux + - Windows + - MacOS + - other + validations: + required: true + - type: textarea + id: hackrf_info output + attributes: + label: What is the output of ```hackrf_info```? + description: Please put the output of the command in the box below or indicate N/A. + placeholder: ```hackrf_info version: unknown + libhackrf version: unknown (0.5) + Found HackRF + Index: 0 + Serial number: 0000000000000000325866e6211d5123 + Board ID Number: 2 (HackRF One) + Firmware Version: git-9a1c0e4e (API:1.06) + Part ID Number: 0xa000cb3c 0x004c4752``` + validations: + required: true + - type: textarea + id: third-party software + attributes: + label: Are you using any third-party software? + description: Please list the software you are using with your HackRF or indicate N/A. Please list version numbers where possible. + placeholder: GNU Radio, GQRX, etc. + validations: + required: true + - type: textarea + id: third-party software + attributes: + label: Are you using any third-party hardware? + description: Please list any hardware you are using with your HackRF or indicate N/A. + placeholder: portapack, specialized antenna, etc. + validations: + required: true diff --git a/issue_template.md b/issue_template.md deleted file mode 100644 index 06f0c9ee..00000000 --- a/issue_template.md +++ /dev/null @@ -1,23 +0,0 @@ -### Steps to reproduce -1. -2. -3. - -### Expected behaviour -Tell us what you expect should happen - -### Actual behaviour -Tell us what happens instead - -### Version information -**Operating system**: - -**hackrf_info output:** - -If you are reporting a problem that involves third party software -(GNU Radio, Gqrx, etc), please report the version here. - -### Output -``` -Insert any commandline or build output here -```