diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000000..5429bbf908 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,62 @@ +name: Bug report +description: Report build and runtime bugs +labels: ["Type: Bug"] +body: + - type: checkboxes + id: checklist + attributes: + label: Answers checklist. + description: Before submitting a new issue, please follow the checklist and try to find the answer. + options: + - label: I have read the component documentation [ESP-IDF Components](https://components.espressif.com) and the issue is not addressed there. + required: true + - label: I am using target and esp-idf version as defined in component's idf_component.yml + required: true + - label: I have searched the [issue tracker](https://github.com/espressif/esp-usb/issues?q=is%3Aissue) for a similar issue and not found any related issue. + required: true + - type: dropdown + id: component + attributes: + label: Which component are you using? If you choose Other, provide details in More Information. + multiple: false + options: + - device/esp_tinyusb + - host/cdc + - host/hid + - host/msc + - host/uvc + - Other + validations: + required: true + - type: input + id: idf_version + attributes: + label: ESP-IDF version. + description: On which ESP-IDF version does this issue occur on? Run `git describe --tags` in your esp-idf folder to find it. + placeholder: ex. v5.0-rc1 + validations: + required: true + - type: input + id: devkit + attributes: + label: Development Kit. + description: On which Development Kit does this issue occur on? + placeholder: ex. ESP32-Wrover-Kit v2 | Custom Board + validations: + required: true + - type: input + id: component_version + attributes: + label: Used Component version. + description: On which Component version does this issue occur on? Check `dependencies.lock` file in your project root to find it. + placeholder: ex. v1.2.0-rc0 + validations: + required: true + - type: textarea + id: more-info + attributes: + label: More Information. + description: Do you have any other information from investigating this? + placeholder: ex. I tried on my friend's Windows 10 PC and the command works there. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml deleted file mode 100644 index d00ee78bda..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ /dev/null @@ -1,86 +0,0 @@ -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, it is preferably compiled like one in example folder and reviewable for people to comment on. The easiest way is - - Fork this repo, checkout a new branch - - Add your-own-example based on stock one - - Push and post it here. - 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: | - Exact steps in chronological order, details should be specific e.g if you use a command/script to test with, please post it as well. - 1. Go to '...' - 2. Click on '....' - 3. See error - validations: - required: true - - - type: textarea - attributes: - label: Debug Log as txt file (LOG/CFG_TUSB_DEBUG=2) - placeholder: | - Attach your debug log txt file here, where the issue occurred, best with comments to explain the actual events. - - Note1: Please DO NOT paste your lengthy log contents here since it hurts the readability. - Note2: 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](https://github.com/hathach/tinyusb/blob/master/docs/getting_started.md) - validations: - required: true - - - type: textarea - attributes: - label: Screenshots - description: If applicable, add screenshots to help explain your problem. - validations: - required: false - - - type: checkboxes - attributes: - label: I have checked existing issues, dicussion and documentation - description: You agree to check all the resources above before opening a new issue. - options: - - label: I confirm I have checked existing issues, dicussion and documentation. - required: true diff --git a/.github/ISSUE_TEMPLATE/config-copy.yml b/.github/ISSUE_TEMPLATE/config-copy.yml new file mode 100644 index 0000000000..0423692e50 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config-copy.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Component Registry + url: https://components.espressif.com + about: Registry with all available ESP-IDF components. + - name: ESP-IDF Programming Guide + url: https://docs.espressif.com/projects/esp-idf/en/latest/ + about: Documentation for configuring and using ESP-IDF. + - name: Espressif documentation page + url: https://www.espressif.com/en/support/download/documents + about: Hardware documentation (datasheets, Technical Reference Manual, etc). + - name: Forum + url: https://esp32.com + about: For questions about using ESP-IDF and/or ESP32 series chips. Please submit all questions starting "How do I..." here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml deleted file mode 100644 index 28fd274674..0000000000 --- a/.github/ISSUE_TEMPLATE/config.yml +++ /dev/null @@ -1,8 +0,0 @@ -blank_issues_enabled: false -contact_links: - - name: TinyUSB Discussion - url: https://github.com/hathach/tinyusb/discussions - about: If you have other questions or need help, post it here. - - name: TinyUSB Docs - url: https://docs.tinyusb.org/ - about: Online documentation diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000000..17b20fb11e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,33 @@ +name: Feature request +description: Suggest an idea or new component for this project. +labels: ["Type: Feature Request"] +body: + - type: markdown + attributes: + value: | + * We welcome any ideas or feature requests! It’s helpful if you can explain exactly why the feature would be useful. + * There are usually some outstanding feature requests in the [existing issues list](https://github.com/espressif/esp-usb/labels/Type%3A%20Feature%20Request), feel free to add comments to them. + - type: textarea + id: problem-related + attributes: + label: Is your feature request related to a problem? + description: Please provide a clear and concise description of what the problem is. + placeholder: ex. I'm always frustrated when ... + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like. + description: Please provide a clear and concise description of what you want to happen. + placeholder: ex. When building my application ... + - type: textarea + id: alternatives + attributes: + label: Describe alternatives you've considered. + description: Please provide a clear and concise description of any alternative solutions or features you've considered. + placeholder: ex. Choosing other approach wouldn't work, because ... + - type: textarea + id: context + attributes: + label: Additional context. + description: Please add any other context or screenshots about the feature request here. + placeholder: ex. This would work only when ... diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml deleted file mode 100644 index 19f403246e..0000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ /dev/null @@ -1,49 +0,0 @@ -name: Feature Request -description: Suggest an idea for this project -labels: 'Feature πŸ’‘' -body: - - type: markdown - attributes: - value: | - Thanks for taking the time to fill out this request! - It's okay to leave some blank if it doesn't apply to your request. - - - type: input - attributes: - label: Related area - description: Please briefly explain the area of your Feature Request. - placeholder: eg. new port support, device stack, class driver ... - validations: - required: true - - - type: input - attributes: - label: Hardware specification - description: Please provide if your proposal depends on specific Hardware. - placeholder: eg. rp2040, samd51 ... - validations: - required: true - - - type: textarea - attributes: - label: Is your feature request related to a problem? - description: Please provide a clear and concise description of what the problem is. Add relevant issue link. - placeholder: ex. I'm facing the issue/missing function... - validations: - required: true - - - type: textarea - attributes: - label: Describe the solution you'd like - description: Please provide a clear and concise description of what you want to happen. - placeholder: ex. When using this function... - validations: - required: true - - - type: checkboxes - attributes: - label: I have checked existing issues, dicussion and documentation - description: You agree to check all the resources above before opening a new issue. - options: - - label: I confirm I have checked existing issues, dicussion and documentation. - required: true diff --git a/.github/ISSUE_TEMPLATE/other-issue.yml b/.github/ISSUE_TEMPLATE/other-issue.yml new file mode 100644 index 0000000000..03a2ae4fee --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other-issue.yml @@ -0,0 +1,21 @@ +name: General issue report +description: File an issue report +body: + - type: checkboxes + id: checklist + attributes: + label: Answers checklist. + description: Before submitting a new issue, please follow the checklist and try to find the answer. + options: + - label: I have read the documentation of the component in question and the issue is not addressed there. + required: true + - label: I have searched the issue tracker for a similar issue and not found a similar issue. + required: true + - type: textarea + id: issue + attributes: + label: General issue report + description: Your issue report goes here. + placeholder: ex. How do I... + validations: + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE/update_component.md b/.github/PULL_REQUEST_TEMPLATE/update_component.md new file mode 100644 index 0000000000..6847687751 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/update_component.md @@ -0,0 +1,9 @@ +# Checklist + +- [ ] Version in idf_component.yml file bumped +- [ ] CHANGELOG.md entry added +- [ ] _Optional:_ README.md updated +- [ ] CI passing + +# Change description +_Please describe your change here_