mirror of
https://github.com/Tencent/WeKnora.git
synced 2025-11-25 03:15:00 +08:00
feat: add issue template
This commit is contained in:
114
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
114
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@@ -0,0 +1,114 @@
|
||||
name: 🐛 Bug 报告
|
||||
description: 报告一个 bug 或问题
|
||||
title: "[Bug]: "
|
||||
labels: ["bug", "needs-triage"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
感谢您报告 bug!请填写以下信息帮助我们快速定位和解决问题。
|
||||
|
||||
- type: dropdown
|
||||
id: component
|
||||
attributes:
|
||||
label: 相关组件
|
||||
description: 选择出现问题的组件
|
||||
options:
|
||||
- 前端界面
|
||||
- 后端服务及API
|
||||
- 文档解析服务
|
||||
- 向量数据库
|
||||
- 模型服务
|
||||
- 其他
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Bug 描述
|
||||
description: 请详细描述遇到的问题
|
||||
placeholder: "请描述 bug 的具体表现..."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: steps
|
||||
attributes:
|
||||
label: 重现步骤
|
||||
description: 重现此 bug 的步骤
|
||||
placeholder: |
|
||||
1. 进入 '...'
|
||||
2. 点击 '...'
|
||||
3. 滚动到 '...'
|
||||
4. 看到错误
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: expected
|
||||
attributes:
|
||||
label: 期望行为
|
||||
description: 描述您期望的正确行为
|
||||
placeholder: "应该发生什么..."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: actual
|
||||
attributes:
|
||||
label: 实际行为
|
||||
description: 描述实际发生的情况
|
||||
placeholder: "实际发生了什么..."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
## 📋 日志收集指南
|
||||
|
||||
请按照以下步骤收集相关日志:
|
||||
|
||||
**1. 应用模块日志:**
|
||||
```bash
|
||||
docker exec -it WeKnora-app tail -f /var/log/WeKnora.log
|
||||
```
|
||||
|
||||
**2. 文档解析模块日志:**
|
||||
```bash
|
||||
docker exec -it WeKnora-docreader tail -f /var/log/docreader.log
|
||||
```
|
||||
|
||||
请重现问题并收集相关日志,然后粘贴到下面的日志字段中。
|
||||
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: 相关日志
|
||||
description: 请按照上面的指南收集并粘贴相关日志
|
||||
placeholder: |
|
||||
请粘贴从以下命令收集的日志:
|
||||
- docker exec -it WeKnora-app tail -f /var/log/WeKnora.log
|
||||
- docker exec -it WeKnora-docreader tail -f /var/log/docreader.log
|
||||
render: shell
|
||||
|
||||
- type: input
|
||||
id: os
|
||||
attributes:
|
||||
label: 操作系统
|
||||
description: 您当前使用的操作系统
|
||||
placeholder: "例如: macOS 13.0, Ubuntu 20.04, Windows 11"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: checkboxes
|
||||
id: terms
|
||||
attributes:
|
||||
label: 确认事项
|
||||
description: 请确认以下事项
|
||||
options:
|
||||
- label: 我已经搜索了现有的 issues,确认这是一个新问题
|
||||
required: true
|
||||
- label: 我已经提供了足够的信息来重现这个问题
|
||||
required: true
|
||||
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: false
|
||||
contact_links:
|
||||
- name: WeKnora 文档
|
||||
url: https://github.com/your-org/WeKnora/blob/main/README.md
|
||||
about: 查看 WeKnora 的使用文档和说明
|
||||
- name: 讨论区
|
||||
url: https://github.com/your-org/WeKnora/discussions
|
||||
about: 在讨论区提问或分享想法
|
||||
88
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
88
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
@@ -0,0 +1,88 @@
|
||||
name: ✨ 功能请求
|
||||
description: 建议新功能或改进现有功能
|
||||
title: "[Feature]: "
|
||||
labels: ["enhancement", "needs-triage"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
感谢您提出功能请求!请详细描述您的建议,这将帮助我们更好地理解您的需求。
|
||||
|
||||
- type: dropdown
|
||||
id: component
|
||||
attributes:
|
||||
label: 相关组件
|
||||
description: 选择功能请求相关的组件
|
||||
options:
|
||||
- 前端界面
|
||||
- 后端服务及API
|
||||
- 文档解析服务
|
||||
- 向量数据库
|
||||
- 模型服务
|
||||
- 配置管理
|
||||
- 其他
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: problem
|
||||
attributes:
|
||||
label: 问题描述
|
||||
description: 请描述您遇到的问题或当前功能的不足
|
||||
placeholder: "当前功能有什么问题或限制?"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: solution
|
||||
attributes:
|
||||
label: 建议的解决方案
|
||||
description: 请详细描述您希望看到的功能或改进
|
||||
placeholder: "您希望如何解决这个问题?"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: alternatives
|
||||
attributes:
|
||||
label: 替代方案
|
||||
description: 描述您考虑过的其他解决方案
|
||||
placeholder: "您是否考虑过其他解决方案?"
|
||||
|
||||
- type: dropdown
|
||||
id: priority
|
||||
attributes:
|
||||
label: 优先级
|
||||
description: 您认为这个功能请求的优先级如何?
|
||||
options:
|
||||
- 低 - 可以稍后考虑
|
||||
- 中 - 有一定价值
|
||||
- 高 - 对工作流程很重要
|
||||
- 紧急 - 阻塞了重要工作
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: usecase
|
||||
attributes:
|
||||
label: 使用场景
|
||||
description: 请描述这个功能的具体使用场景
|
||||
placeholder: "在什么情况下您会使用这个功能?"
|
||||
|
||||
- type: textarea
|
||||
id: additional
|
||||
attributes:
|
||||
label: 补充信息
|
||||
description: 任何其他相关信息、截图或链接
|
||||
placeholder: "添加任何其他相关信息..."
|
||||
|
||||
- type: checkboxes
|
||||
id: terms
|
||||
attributes:
|
||||
label: 确认事项
|
||||
description: 请确认以下事项
|
||||
options:
|
||||
- label: 我已经搜索了现有的 issues,确认这是一个新的功能请求
|
||||
required: true
|
||||
- label: 我理解这个功能请求可能需要讨论和评估
|
||||
required: true
|
||||
108
.github/ISSUE_TEMPLATE/question.yml
vendored
Normal file
108
.github/ISSUE_TEMPLATE/question.yml
vendored
Normal file
@@ -0,0 +1,108 @@
|
||||
name: ❓ 问题咨询
|
||||
description: 询问关于 WeKnora 的问题或寻求帮助
|
||||
title: "[Question]: "
|
||||
labels: ["question", "needs-triage"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
欢迎提问!请提供足够的信息,这样我们就能更好地帮助您。
|
||||
|
||||
- type: dropdown
|
||||
id: category
|
||||
attributes:
|
||||
label: 问题类别
|
||||
description: 选择您的问题类别
|
||||
options:
|
||||
- 安装和部署
|
||||
- 配置问题
|
||||
- 使用问题
|
||||
- 性能问题
|
||||
- 集成问题
|
||||
- 其他
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: question
|
||||
attributes:
|
||||
label: 问题描述
|
||||
description: 请详细描述您的问题
|
||||
placeholder: "您遇到了什么问题?需要什么帮助?"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: context
|
||||
attributes:
|
||||
label: 背景信息
|
||||
description: 请提供相关的背景信息
|
||||
placeholder: |
|
||||
- 您正在尝试做什么?
|
||||
- 您期望的结果是什么?
|
||||
- 您已经尝试了什么?
|
||||
|
||||
- type: input
|
||||
id: os
|
||||
attributes:
|
||||
label: 操作系统
|
||||
description: 您当前使用的操作系统
|
||||
placeholder: "例如: macOS 13.0, Ubuntu 20.04, Windows 11"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: environment
|
||||
attributes:
|
||||
label: 其他环境信息
|
||||
description: 请提供其他相关的环境信息
|
||||
placeholder: |
|
||||
- WeKnora 版本: [例如: v1.0.0]
|
||||
- 部署方式: [例如: Docker, 源码编译]
|
||||
- 其他相关信息...
|
||||
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
## 📋 日志收集指南(如需要)
|
||||
|
||||
如果问题涉及错误或需要调试,请收集相关日志:
|
||||
|
||||
**应用模块日志:**
|
||||
```bash
|
||||
docker exec -it WeKnora-app tail -f /var/log/WeKnora.log
|
||||
```
|
||||
|
||||
**文档解析模块日志:**
|
||||
```bash
|
||||
docker exec -it WeKnora-docreader tail -f /var/log/docreader.log
|
||||
```
|
||||
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: 相关日志
|
||||
description: 如果有相关日志或错误信息,请粘贴在这里
|
||||
placeholder: "粘贴相关日志或错误信息..."
|
||||
render: shell
|
||||
|
||||
- type: textarea
|
||||
id: research
|
||||
attributes:
|
||||
label: 已查找的资源
|
||||
description: 请列出您已经查看过的文档、issues 或其他资源
|
||||
placeholder: |
|
||||
- 已查看的文档: [例如: README.md, API.md]
|
||||
- 已查看的 issues: [例如: #123, #456]
|
||||
- 其他资源: [例如: 官方文档, Stack Overflow]
|
||||
|
||||
- type: checkboxes
|
||||
id: terms
|
||||
attributes:
|
||||
label: 确认事项
|
||||
description: 请确认以下事项
|
||||
options:
|
||||
- label: 我已经搜索了现有的 issues 和文档
|
||||
required: true
|
||||
- label: 我已经提供了足够的信息来帮助理解问题
|
||||
required: true
|
||||
Reference in New Issue
Block a user