Skip to content

Commit

Permalink
add issues template
Browse files Browse the repository at this point in the history
  • Loading branch information
successren committed Jan 7, 2024
1 parent f7aa39a commit 0fce0a7
Show file tree
Hide file tree
Showing 4 changed files with 102 additions and 0 deletions.
99 changes: 99 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
name: 🐞 Bug
description: 提交错误报告 | File a bug/issue
title: "[BUG] <title>"
labels: []
body:
- type: checkboxes
attributes:
label: 是否已有关于该错误的issue或讨论? | Is there an existing issue / discussion for this?
description: |
请先搜索您遇到的错误是否在已有的issues或讨论中提到过。
Please search to see if an issue / discussion already exists for the bug you encountered.
[Issues](https://github.com/netease-youdao/QAnything/issues)
options:
- label: 我已经搜索过已有的issues和讨论 | I have searched the existing issues / discussions
required: true
- type: checkboxes
attributes:
label: 该问题是否在FAQ中有解答? | Is there an existing answer for this in FAQ?
description: |
请先搜索您遇到的错误是否已在FAQ中有相关解答。
Please search to see if an answer already exists in FAQ for the bug you encountered.
[FAQ-en](https://github.com/netease-youdao/QAnything/blob/main/FAQ.md)
[FAQ-zh](https://github.com/netease-youdao/QAnything/blob/main/FAQ_zh.md)
options:
- label: 我已经搜索过FAQ | I have searched FAQ
required: true
- type: textarea
attributes:
label: 当前行为 | Current Behavior
description: |
准确描述遇到的行为。
A concise description of what you're experiencing.
validations:
required: false
- type: textarea
attributes:
label: 期望行为 | Expected Behavior
description: |
准确描述预期的行为。
A concise description of what you expected to happen.
validations:
required: false
- type: textarea
attributes:
label: 复现方法 | Steps To Reproduce
description: |
复现当前行为的详细步骤。
Steps to reproduce the behavior.
placeholder: |
1. In this environment...
2. With this config...
3. Run '...'
4. See error...
validations:
required: false
- type: textarea
attributes:
label: 运行环境 | Environment
description: |
examples:
- **OS**: Ubuntu 20.04 / Windows 11 WSL2
- **NVIDIA Driver**: 525.105.17
- **CUDA**: 12.0
- **Docker Compose**: 1.27.4
- **NVIDIA GPU Memory**: 16GB
value: |
- OS:
- NVIDIA Driver:
- CUDA:
- Docker Compose:
- NVIDIA GPU Memory:
render: Markdown
validations:
required: false
- type: textarea
attributes:
label: QAnything日志 | QAnything logs
description: |
在QAnything项目根目录下找到api.log,把关键信息粘贴到这里。
Find the api.log file in the root directory of the QAnything project and paste the key information here.
placeholder: |
把api.log的关键内容贴到这里
paste api.log key content here.
validations:
required: false

- type: textarea
attributes:
label: 备注 | Anything else?
description: |
您可以在这里补充其他关于该问题背景信息的描述、链接或引用等。
您可以通过点击高亮此区域然后拖动文件的方式上传图片或日志文件。
Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ venv
__pycache__
QANY_DB
qanything_logs
api.log
1 change: 1 addition & 0 deletions FAQ.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
## coming soon...
1 change: 1 addition & 0 deletions FAQ_zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
## 敬请期待

0 comments on commit 0fce0a7

Please sign in to comment.