Skip to content

Commit 8900aa4

Browse files
lyingbuglyingbug
committed
feat: add issue template
1 parent 3ce5ffb commit 8900aa4

File tree

4 files changed

+318
-0
lines changed

4 files changed

+318
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
name: 🐛 Bug 报告
2+
description: 报告一个 bug 或问题
3+
title: "[Bug]: "
4+
labels: ["bug", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
感谢您报告 bug！请填写以下信息帮助我们快速定位和解决问题。
10+
11+
- type: dropdown
12+
id: component
13+
attributes:
14+
label: 相关组件
15+
description: 选择出现问题的组件
16+
options:
17+
- 前端界面
18+
- 后端服务及API
19+
- 文档解析服务
20+
- 向量数据库
21+
- 模型服务
22+
- 其他
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: description
28+
attributes:
29+
label: Bug 描述
30+
description: 请详细描述遇到的问题
31+
placeholder: "请描述 bug 的具体表现..."
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: steps
37+
attributes:
38+
label: 重现步骤
39+
description: 重现此 bug 的步骤
40+
placeholder: |
41+
1. 进入 '...'
42+
2. 点击 '...'
43+
3. 滚动到 '...'
44+
4. 看到错误
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: expected
50+
attributes:
51+
label: 期望行为
52+
description: 描述您期望的正确行为
53+
placeholder: "应该发生什么..."
54+
validations:
55+
required: true
56+
57+
- type: textarea
58+
id: actual
59+
attributes:
60+
label: 实际行为
61+
description: 描述实际发生的情况
62+
placeholder: "实际发生了什么..."
63+
validations:
64+
required: true
65+
66+
- type: markdown
67+
attributes:
68+
value: |
69+
## 📋 日志收集指南
70+
71+
请按照以下步骤收集相关日志：
72+
73+
**1. 应用模块日志：**
74+
```bash
75+
docker exec -it WeKnora-app tail -f /var/log/WeKnora.log
76+
```
77+
78+
**2. 文档解析模块日志：**
79+
```bash
80+
docker exec -it WeKnora-docreader tail -f /var/log/docreader.log
81+
```
82+
83+
请重现问题并收集相关日志，然后粘贴到下面的日志字段中。
84+
85+
- type: textarea
86+
id: logs
87+
attributes:
88+
label: 相关日志
89+
description: 请按照上面的指南收集并粘贴相关日志
90+
placeholder: |
91+
请粘贴从以下命令收集的日志：
92+
- docker exec -it WeKnora-app tail -f /var/log/WeKnora.log
93+
- docker exec -it WeKnora-docreader tail -f /var/log/docreader.log
94+
render: shell
95+
96+
- type: input
97+
id: os
98+
attributes:
99+
label: 操作系统
100+
description: 您当前使用的操作系统
101+
placeholder: "例如: macOS 13.0, Ubuntu 20.04, Windows 11"
102+
validations:
103+
required: true
104+
105+
- type: checkboxes
106+
id: terms
107+
attributes:
108+
label: 确认事项
109+
description: 请确认以下事项
110+
options:
111+
- label: 我已经搜索了现有的 issues，确认这是一个新问题
112+
required: true
113+
- label: 我已经提供了足够的信息来重现这个问题
114+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: WeKnora 文档
4+
url: https://github.com/your-org/WeKnora/blob/main/README.md
5+
about: 查看 WeKnora 的使用文档和说明
6+
- name: 讨论区
7+
url: https://github.com/your-org/WeKnora/discussions
8+
about: 在讨论区提问或分享想法

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
name: ✨ 功能请求
2+
description: 建议新功能或改进现有功能
3+
title: "[Feature]: "
4+
labels: ["enhancement", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
感谢您提出功能请求！请详细描述您的建议，这将帮助我们更好地理解您的需求。
10+
11+
- type: dropdown
12+
id: component
13+
attributes:
14+
label: 相关组件
15+
description: 选择功能请求相关的组件
16+
options:
17+
- 前端界面
18+
- 后端服务及API
19+
- 文档解析服务
20+
- 向量数据库
21+
- 模型服务
22+
- 配置管理
23+
- 其他
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: problem
29+
attributes:
30+
label: 问题描述
31+
description: 请描述您遇到的问题或当前功能的不足
32+
placeholder: "当前功能有什么问题或限制？"
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: solution
38+
attributes:
39+
label: 建议的解决方案
40+
description: 请详细描述您希望看到的功能或改进
41+
placeholder: "您希望如何解决这个问题？"
42+
validations:
43+
required: true
44+
45+
- type: textarea
46+
id: alternatives
47+
attributes:
48+
label: 替代方案
49+
description: 描述您考虑过的其他解决方案
50+
placeholder: "您是否考虑过其他解决方案？"
51+
52+
- type: dropdown
53+
id: priority
54+
attributes:
55+
label: 优先级
56+
description: 您认为这个功能请求的优先级如何？
57+
options:
58+
- 低 - 可以稍后考虑
59+
- 中 - 有一定价值
60+
- 高 - 对工作流程很重要
61+
- 紧急 - 阻塞了重要工作
62+
validations:
63+
required: true
64+
65+
- type: textarea
66+
id: usecase
67+
attributes:
68+
label: 使用场景
69+
description: 请描述这个功能的具体使用场景
70+
placeholder: "在什么情况下您会使用这个功能？"
71+
72+
- type: textarea
73+
id: additional
74+
attributes:
75+
label: 补充信息
76+
description: 任何其他相关信息、截图或链接
77+
placeholder: "添加任何其他相关信息..."
78+
79+
- type: checkboxes
80+
id: terms
81+
attributes:
82+
label: 确认事项
83+
description: 请确认以下事项
84+
options:
85+
- label: 我已经搜索了现有的 issues，确认这是一个新的功能请求
86+
required: true
87+
- label: 我理解这个功能请求可能需要讨论和评估
88+
required: true

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
name: ❓ 问题咨询
2+
description: 询问关于 WeKnora 的问题或寻求帮助
3+
title: "[Question]: "
4+
labels: ["question", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
欢迎提问！请提供足够的信息，这样我们就能更好地帮助您。
10+
11+
- type: dropdown
12+
id: category
13+
attributes:
14+
label: 问题类别
15+
description: 选择您的问题类别
16+
options:
17+
- 安装和部署
18+
- 配置问题
19+
- 使用问题
20+
- 性能问题
21+
- 集成问题
22+
- 其他
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: question
28+
attributes:
29+
label: 问题描述
30+
description: 请详细描述您的问题
31+
placeholder: "您遇到了什么问题？需要什么帮助？"
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: context
37+
attributes:
38+
label: 背景信息
39+
description: 请提供相关的背景信息
40+
placeholder: |
41+
- 您正在尝试做什么？
42+
- 您期望的结果是什么？
43+
- 您已经尝试了什么？
44+
45+
- type: input
46+
id: os
47+
attributes:
48+
label: 操作系统
49+
description: 您当前使用的操作系统
50+
placeholder: "例如: macOS 13.0, Ubuntu 20.04, Windows 11"
51+
validations:
52+
required: true
53+
54+
- type: textarea
55+
id: environment
56+
attributes:
57+
label: 其他环境信息
58+
description: 请提供其他相关的环境信息
59+
placeholder: |
60+
- WeKnora 版本: [例如: v1.0.0]
61+
- 部署方式: [例如: Docker, 源码编译]
62+
- 其他相关信息...
63+
64+
- type: markdown
65+
attributes:
66+
value: |
67+
## 📋 日志收集指南（如需要）
68+
69+
如果问题涉及错误或需要调试，请收集相关日志：
70+
71+
**应用模块日志：**
72+
```bash
73+
docker exec -it WeKnora-app tail -f /var/log/WeKnora.log
74+
```
75+
76+
**文档解析模块日志：**
77+
```bash
78+
docker exec -it WeKnora-docreader tail -f /var/log/docreader.log
79+
```
80+
81+
- type: textarea
82+
id: logs
83+
attributes:
84+
label: 相关日志
85+
description: 如果有相关日志或错误信息，请粘贴在这里
86+
placeholder: "粘贴相关日志或错误信息..."
87+
render: shell
88+
89+
- type: textarea
90+
id: research
91+
attributes:
92+
label: 已查找的资源
93+
description: 请列出您已经查看过的文档、issues 或其他资源
94+
placeholder: |
95+
- 已查看的文档: [例如: README.md, API.md]
96+
- 已查看的 issues: [例如: #123, #456]
97+
- 其他资源: [例如: 官方文档, Stack Overflow]
98+
99+
- type: checkboxes
100+
id: terms
101+
attributes:
102+
label: 确认事项
103+
description: 请确认以下事项
104+
options:
105+
- label: 我已经搜索了现有的 issues 和文档
106+
required: true
107+
- label: 我已经提供了足够的信息来帮助理解问题
108+
required: true

0 commit comments

Comments
 (0)