add issue template

2025-02-20 15:22:29 +08:00
parent cd2fbf2a25
commit e123e37f7d
4 changed files with 260 additions and 0 deletions
--- a/.github/ISSUE_TEMPLATE/02_runtime_bug.yml
+++ b/.github/ISSUE_TEMPLATE/02_runtime_bug.yml
@@ -0,0 +1,115 @@
+name: Runtime bug report
+description: Report runtime bugs
+labels: ['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 [XiaoZhi AI Programming Guide](https://ccnphfhqs21z.feishu.cn/wiki/F5krwD16viZoF0kKkvDcrZNYnhb) and the issue is not addressed there.
+          required: true
+        - label: I have updated my firmware 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: input
+    id: xiaozhi_ai_firmware_version
+    attributes:
+      label: XiaoZhi AI firmware version.
+      description: On which firmware version does this issue occur on?
+      placeholder: ex. v1.2.1_bread-compact-wifi
+    validations:
+      required: true
+  - type: dropdown
+    id: operating_system
+    attributes:
+      label: Operating System used.
+      multiple: false
+      options:
+        - Windows
+        - Linux
+        - macOS
+    validations:
+      required: true
+  - type: dropdown
+    id: build
+    attributes:
+      label: How did you build your project?
+      multiple: false
+      options:
+        - Command line with CMake
+        - Command line with idf.py
+        - CLion IDE
+        - VS Code IDE/Cursor
+        - Other (please specify in More Information)
+    validations:
+      required: true
+  - type: dropdown
+    id: windows_comand_line
+    attributes:
+      label: If you are using Windows, please specify command line type.
+      multiple: false
+      options:
+        - PowerShell
+        - CMD
+    validations:
+      required: false
+  - type: dropdown
+    id: power_supply
+    attributes:
+      label: Power Supply used.
+      multiple: false
+      options:
+        - USB
+        - External 5V
+        - External 3.3V
+        - Battery
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: What is the expected behavior?
+      description: Please provide a clear and concise description of the expected behavior.
+      placeholder: I expected it to...
+    validations:
+      required: true
+  - type: textarea
+    id: actual
+    attributes:
+      label: What is the actual behavior?
+      description: Please describe actual behavior.
+      placeholder: Instead it...
+    validations:
+      required: true
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to reproduce.
+      description: 'How do you trigger this bug? Please walk us through it step by step. Please attach your code here.'
+      value: |
+        1. Step
+        2. Step
+        3. Step
+        ...
+    validations:
+      required: true
+  - type: textarea
+    id: debug_logs
+    attributes:
+      label: Debug Logs.
+      description: Debug log goes here, should contain the backtrace, as well as the reset source if it is a crash.
+      placeholder: Your log goes here.
+      render: plain
+    validations:
+      required: false
+  - type: textarea
+    id: more-info
+    attributes:
+      label: More Information.
+      description: Do you have any other information from investigating this?
+      placeholder: ex. Any more.
+    validations:
+      required: false