diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 000000000..875e5ed18 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,45 @@ +name: Installation or build bug report +description: Report installation or build 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 documentation for [esp-protocols components](https://espressif.github.io/esp-protocols/) and the issue is not addressed there. + required: true + - label: I have updated my esp-protocols branch (master or release) to the latest version and checked that the issue is present there. + required: true + - label: I have searched the issue tracker for a similar issue and not found a similar issue. + required: true + - type: dropdown + id: component + attributes: + label: What component are you using? If you choose Other, provide details in More Information. + multiple: false + options: + - ASIO port + - esp_modem + - esp_websocket_client + - mDNS + - Other + validations: + required: true + - type: input + id: idf_version + attributes: + label: IDF version. + description: On which IDF version does this issue occur on? Run `git describe --tags` to find it. + placeholder: ex. v3.2-dev-1148-g96cd3b75c + 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/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..6adfa7b74 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: esp-protocols documentation + url: https://espressif.github.io/esp-protocols/ + about: Documenation for esp-protocols 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/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 000000000..46285d533 --- /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-protocols/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/other-issue.yml b/.github/ISSUE_TEMPLATE/other-issue.yml new file mode 100644 index 000000000..64d8a9991 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other-issue.yml @@ -0,0 +1,23 @@ +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 for [esp-protocols components](https://espressif.github.io/esp-protocols/) and the issue is not addressed there. + required: true + - label: I have updated my esp-protocols branch (master or release) to the latest version and checked that the issue is present 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