summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorhathach <[email protected]>2021-06-28 16:25:22 +0700
committerhathach <[email protected]>2021-06-28 16:25:22 +0700
commit35eaa4a4e3a66e909707201c22ea61f97b331793 (patch)
tree5c5ce7d603d0491d396c0f16b1d5e2b1bb392ad4
parent01987ef86c677c50c3dc5e83f3278fcd0edd4e82 (diff)
Use bug report form
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md35
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.yml71
2 files changed, 71 insertions, 35 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index 3beef45d0..000000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,35 +0,0 @@
----
-name: Bug Report
-about: Create a report to help us improve
-title: 'Please provide all details at least for Setup/Describe/Reproduce'
-labels: Bug 🐞
-assignees: ''
-
----
-
-**Set Up**
-
-- **PC OS** e.g Ubuntu 20.04 / Windows 10 / macOS 10.15
-- **Board** e.g Feather nRF52840 Express (if custom specify your MCUs)
-- **TinyUSB version** relase version or git hash (preferrably running with master for lastest code)
-- **Firmware** e.g examples/device/cdc_msc
-
-**Describe The Bug**
-
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. See error
-
-**Screenshots**
-
-If applicable, add screenshots, bus capture to help explain your problem.
-
-**Log**
-
-If applicable, provide the stack's log (uart/rtt/swo) where the issue occurred as attached txt file, best with comments to explain the actual events.
-Note: To enable logging, add `LOG=2` to to the make command if building with stock examples or set `CFG_TUSB_DEBUG=2` in your tusb_config.h. More information can be found at [example's readme](/docs/getting_started.md)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 000000000..41b9185a5
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,71 @@
+name: Bug Report
+description: Report a problem with TinyUSB.
+title: ''
+labels: Bug 🐞
+assignees: ''
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thanks for taking the time to fill out this bug report!
+ It's okay to leave some blank if it doesn't apply to your problem.
+
+ - type: dropdown
+ attributes:
+ label: Operating System
+ validations:
+ required: true
+ options:
+ - Linux
+ - MacOS
+ - RaspberryPi OS
+ - Windows 7
+ - Windows 10
+ - Windows 11
+ - Others
+
+ - type: input
+ attributes:
+ label: Board
+ placeholder: e.g Feather nRF52840 Express
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: Firmware
+ placeholder: e.g examples/device/cdc_msc. If it is custom firmware, please provide links to your minimal sources or as attached files.
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: What happened ?
+ placeholder: A clear and concise description of what the bug is.
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: How to reproduce ?
+ placeholder: |
+ 1. Go to '...'
+ 2. Click on '....'
+ 3. See error
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: Debug Log
+ placeholder: |
+ TinyUSB debug log where the issue occurred as attached txt file, best with comments to explain the actual events.
+ Note: To enable logging, add `LOG=3` to to the make command if building with stock examples or set `CFG_TUSB_DEBUG=3` in your tusb_config.h. More information can be found at [example's readme](/docs/getting_started.md)
+ validations:
+ required: false
+
+ - type: textarea
+ attributes:
+ label: Screenshots (if any)
+ validations:
+ required: false