Skip to content

Commit

Permalink
change(tinyusb): Added repo templates for issue and pull request
Browse files Browse the repository at this point in the history
  • Loading branch information
roma-jam committed Oct 31, 2024
1 parent fc869d3 commit cba227a
Show file tree
Hide file tree
Showing 8 changed files with 139 additions and 143 deletions.
62 changes: 62 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -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
86 changes: 0 additions & 86 deletions .github/ISSUE_TEMPLATE/bug_report.yml

This file was deleted.

14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/config-copy.yml
Original file line number Diff line number Diff line change
@@ -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.
8 changes: 0 additions & 8 deletions .github/ISSUE_TEMPLATE/config.yml

This file was deleted.

33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -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 ...
49 changes: 0 additions & 49 deletions .github/ISSUE_TEMPLATE/feature_request.yml

This file was deleted.

21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/other-issue.yml
Original file line number Diff line number Diff line change
@@ -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
9 changes: 9 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/update_component.md
Original file line number Diff line number Diff line change
@@ -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_

0 comments on commit cba227a

Please sign in to comment.