diff options
Diffstat (limited to '.github')
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 24 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.md | 2 |
2 files changed, 15 insertions, 11 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 9f956f9d8..797f6f924 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,29 +1,33 @@ --- -name: Bug report +name: Bug Report about: Create a report to help us improve -title: '' +title: 'Please provide all details at least for Setup/Describe/Reproduce' labels: Bug 🐞 assignees: '' --- -**Set up** -[Mandatory] Provide details of your setup help us to reproduce the issue as quick as possible - - **PC OS** : Ubuntu 18.04 / Windows 10/ macOS 10.15 - - **Board** : Feather nRF52840 Express - - **Firmware**: examples/device/cdc_msc +**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) +- **Firmware** e.g examples/device/cdc_msc + +**Describe The Bug** -**Describe the bug** A clear and concise description of what the bug is. -**To reproduce** +**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** -Please provide the stack's log (uart/rtt/swo) where the issue occurred, best with comments to explain the actual events. 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) + +If applicable, provide the stack's log (uart/rtt/swo) where the issue occurred, best with comments to explain the actual events. 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/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 9842a229f..562d3113b 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,5 +1,5 @@ --- -name: Feature request +name: Feature Request about: Suggest an idea for this project title: '' labels: Feature 💡 |