소스 검색

Merge branch 'feature/add_github_issue_template' into 'master'

feature: Add GitHub issue templates

Closes ESF-46

See merge request espressif/esp-serial-flasher!64
Roland Dobai 2 년 전
부모
커밋
ae83fd8a0a
2개의 변경된 파일81개의 추가작업 그리고 0개의 파일을 삭제
  1. 47 0
      .github/ISSUE_TEMPLATE/bug_report.yml
  2. 34 0
      .github/ISSUE_TEMPLATE/feature_request.yml

+ 47 - 0
.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,47 @@
+name: Bug report
+description: Report a problem with esp-serial-flasher operation
+labels: ['Type: Bug']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        * Please ensure you are using the latest version of `esp-serial-flasher`.
+        * Try using one of the examples from the `examples` directory and following the example documentation.
+        * If your board is a custom design, consider using our [free-of-charge schematic and PCB review service](https://www.espressif.com/en/contact-us/circuit-schematic-pcb-design-review).
+        * If still experiencing issues, please provide as many details as possible below about your hardware and software setup.
+  - type: input
+    id: port
+    attributes:
+      label: Port
+      description: Which port are you experiencing the issue with?
+      placeholder: ex. ESP, STM32
+    validations:
+      required: true
+  - type: input
+    id: target
+    attributes:
+      label: Target chip
+      description: Which chip are you trying to flash?
+      placeholder: ex. ESP8266, ESP32, ESP32-C3
+    validations:
+      required: true
+  - type: textarea
+    id: other-hw
+    attributes:
+      label: Hardware Configuration
+      description: What dev boards/custom PCB are you using, how are the chips connected, which baudrate are you trying to flash with?
+    validations:
+      required: true
+    id: output
+  - type: textarea
+    attributes:
+      label: Log output
+      description: Provide the full output log.
+      render: plain
+    validations:
+      required: true
+  - type: textarea
+    id: more-info
+    attributes:
+      label: More Information
+      description: Provide any additional information relevant to the issue.

+ 34 - 0
.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,34 @@
+name: Feature request
+description: Suggest an idea 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.
+        * Please check if the feature has already been suggested in [existing issues](https://github.com/espressif/esp-serial-flasher/issues) or [pull requests](https://github.com/espressif/esp-serial-flasher/pulls).
+        * Please provide enough context so that the reasoning behind the suggestion can be understood.
+  - 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.
+    validations:
+      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: Describe the solution you'd like
+      description: Please provide a clear and concise description of a solution of the described problem or usecase.
+    validations:
+      required: true
+  - 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.
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description: Please add any other context here.