summaryrefslogtreecommitdiffstats
path: root/tinyusb/.github/ISSUE_TEMPLATE
diff options
context:
space:
mode:
Diffstat (limited to 'tinyusb/.github/ISSUE_TEMPLATE')
-rwxr-xr-xtinyusb/.github/ISSUE_TEMPLATE/bug_report.yml74
-rwxr-xr-xtinyusb/.github/ISSUE_TEMPLATE/config.yml4
-rwxr-xr-xtinyusb/.github/ISSUE_TEMPLATE/feature_request.md14
3 files changed, 92 insertions, 0 deletions
diff --git a/tinyusb/.github/ISSUE_TEMPLATE/bug_report.yml b/tinyusb/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100755
index 00000000..291b2207
--- /dev/null
+++ b/tinyusb/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,74 @@
+name: Bug Report
+description: Report a problem with TinyUSB
+labels: 'Bug 🐞'
+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
+ options:
+ - Linux
+ - MacOS
+ - RaspberryPi OS
+ - Windows 7
+ - Windows 10
+ - Windows 11
+ - Others
+ validations:
+ required: true
+
+ - 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](https://github.com/hathach/tinyusb/blob/master/docs/getting_started.md)
+ validations:
+ required: false
+
+ - type: textarea
+ attributes:
+ label: Screenshots
+ description: If applicable, add screenshots to help explain your problem.
+ validations:
+ required: false
diff --git a/tinyusb/.github/ISSUE_TEMPLATE/config.yml b/tinyusb/.github/ISSUE_TEMPLATE/config.yml
new file mode 100755
index 00000000..735a5ef2
--- /dev/null
+++ b/tinyusb/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,4 @@
+contact_links:
+ - name: TinyUSB Discussion
+ url: https://github.com/hathach/tinyusb/discussions
+ about: If you have other questions or need help, post it here.
diff --git a/tinyusb/.github/ISSUE_TEMPLATE/feature_request.md b/tinyusb/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100755
index 00000000..562d3113
--- /dev/null
+++ b/tinyusb/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,14 @@
+---
+name: Feature Request
+about: Suggest an idea for this project
+title: ''
+labels: Feature 💡
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.