forked from xiaozhi/xiaozhi-esp32
add issue template
This commit is contained in:
飞雪无情
103
.github/ISSUE_TEMPLATE/01_build_install_bug.yml
vendored
Normal file
103
.github/ISSUE_TEMPLATE/01_build_install_bug.yml
vendored
Normal file
@@ -0,0 +1,103 @@
|
|||||||
|
name: Installation or build bug report
|
||||||
|
description: Report installation or build 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 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: input
|
||||||
|
id: xiaozhi_ai_version
|
||||||
|
attributes:
|
||||||
|
label: XiaoZhi AI version.
|
||||||
|
description: On which XiaoZhi AI version does this issue occur on? Run `git describe --tags` to find it.
|
||||||
|
placeholder: ex. v1.1.0-44-g140aab8
|
||||||
|
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: 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. If this is build bug, please attach sdkconfig file (from your project folder). Please attach your code here.'
|
||||||
|
value: |
|
||||||
|
1. Step
|
||||||
|
2. Step
|
||||||
|
3. Step
|
||||||
|
...
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: debug_logs
|
||||||
|
attributes:
|
||||||
|
label: Build or installation Logs.
|
||||||
|
description: Build or installation 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
|
||||||
115
.github/ISSUE_TEMPLATE/02_runtime_bug.yml
vendored
Normal file
115
.github/ISSUE_TEMPLATE/02_runtime_bug.yml
vendored
Normal file
@@ -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
|
||||||
34
.github/ISSUE_TEMPLATE/03_feature_request.yml
vendored
Normal file
34
.github/ISSUE_TEMPLATE/03_feature_request.yml
vendored
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
name: Feature request
|
||||||
|
description: Suggest an idea for this project.
|
||||||
|
labels: ['enhancement']
|
||||||
|
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/78/xiaozhi-esp32/labels/enhancement), feel free to add comments to them.
|
||||||
|
* If you would like to contribute, please read the [contributions guide](https://ccnphfhqs21z.feishu.cn/wiki/F5krwD16viZoF0kKkvDcrZNYnhb).
|
||||||
|
- 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 using XiaoZhi ...
|
||||||
|
- 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 ...
|
||||||
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
blank_issues_enabled: true
|
||||||
|
contact_links:
|
||||||
|
- name: 小智 AI 官方网站
|
||||||
|
url: https://xiaozhi.me/
|
||||||
|
about: 激活设备、配置 AI、声纹识别、声音克隆等应有尽有，DIY 属于你自己的小智
|
||||||
|
- name: 小智 AI 聊天机器人百科全书
|
||||||
|
url: https://ccnphfhqs21z.feishu.cn/wiki/F5krwD16viZoF0kKkvDcrZNYnhb
|
||||||
|
about: 开发文档、硬件制作、烧录教程、FAQ尽在小智百科
|
||||||
Reference in New Issue
Block a user