Update issue templates

This commit is contained in:
cc
2026-03-16 21:14:11 +08:00
committed by GitHub
parent 0845ee6775
commit 85b5943b9e
7 changed files with 168 additions and 0 deletions

31
.github/ISSUE_TEMPLATE/bug-报告.md vendored Normal file
View File

@@ -0,0 +1,31 @@
---
name: Bug 报告
about: 报告发现的问题,帮助我们修复它
title: "[Bug]: <在这里简述问题>"
labels: 'type: bug'
assignees: ''
---
## 问题描述
<!-- 请简要描述你遇到的问题,以及它在什么情况下发生 -->
## 复现步骤
<!-- 告诉我们如何重现这个 Bug步骤越详细越好 -->
1. 第一步...
2. 第二步...
3. 看到错误结果...
## 预期行为
<!-- 描述你期望看到的结果是什么 -->
## 截图 / 录屏
<!-- 如果可能,请上传相关截图或录屏来直观展示问题 -->
## 环境信息
- **操作系统:** (例如: Windows 11 / macOS 26)
- **版本号:** (例如: v5.2.0/源码开发)
- **相关依赖(仅源码编译时需要提供此项):** (例如: Node.js 20)
## 额外信息
<!-- 任何其他有助于定位问题的日志或上下文信息 -->

20
.github/ISSUE_TEMPLATE/性能优化.md vendored Normal file
View File

@@ -0,0 +1,20 @@
---
name: 性能优化
about: 报告性能瓶颈并提议优化方案
title: "[PERF]: <优化点名称>"
labels: 'type: enhancement'
assignees: ''
---
## 当前性能现状
<!-- 请提供具体的度量数据。例如:加载时间 5s内存占用 500MB 等 -->
## 瓶颈分析
<!-- 是否使用了 Profiling 工具(如 Chrome DevTools, PySpy 等)?请附上截图或日志 -->
## 预期优化目标
<!-- 优化后希望达到的数值 -->
## 优化思路
<!-- 你的方案(例如:增加缓存、改异步、算法优化 -->

20
.github/ISSUE_TEMPLATE/技术询问.md vendored Normal file
View File

@@ -0,0 +1,20 @@
---
name: 技术询问
about: 如果你对使用方法有疑问,可以在这里提问
title: "[Q&A]: <在这里简述你的疑问>"
labels: 'type: question'
assignees: ''
---
## 你的问题是什么?
<!-- 请清晰地描述你想咨询的内容 -->
## 你已经尝试过的方法
<!-- 为了避免重复建议,请说明你已经查阅了哪些文档或做过哪些尝试 -->
## 相关代码片段 (如果有)
<!-- 如果涉及代码,请粘贴在这里 -->
```javascript
// 代码示例
```

20
.github/ISSUE_TEMPLATE/文档改进.md vendored Normal file
View File

@@ -0,0 +1,20 @@
---
name: 文档改进
about: 修正文档错误或补充说明
title: "[DOCS]: <文档位置或主题>"
labels: 'type: docs'
assignees: ''
---
## 相关文档链接
<!-- 请贴出需要修改的文档 URL -->
## 当前问题
<!-- 文档哪里写错了?或者哪里描述不够清晰? -->
## 建议修改内容
<!-- 你希望改成什么样?欢迎直接给出修改后的文字或代码块 -->
## 我可以贡献 PR
- [ ] 是的,我愿意认领此任务并提交 Pull Request

View File

@@ -0,0 +1,20 @@
---
name: 现有功能改进
about: " 提交你的想法,让这个项目变得更好"
title: "[Enhancement]: <在这里简述你的需求>"
labels: 'type: enhancement'
assignees: ''
---
## 是否遇到了具体的问题?
<!-- 描述当前有什么不便之处,或者为什么需要这个这些改进 -->
## 你的建议
<!-- 详细描述希望功能可以变成什么样 -->
## 备选方案
<!-- 是否考虑过其他解决方法?或者目前的临时替代方案是什么? -->
## 备注
<!-- 任何有助于理解这个需求的补充说明或设计初稿 -->

View File

@@ -0,0 +1,21 @@
---
name: 重构与技术债
about: 针对现有代码结构的优化,不涉及业务逻辑改变
title: "[REFACTOR]: <重构模块名>"
labels: 'priority: high'
assignees: ''
---
## 重构背景
<!-- 当前的屎山代码存在什么问题?(如:耦合严重、重复代码、逻辑混乱、性能瓶颈) -->
## 技术债描述
<!-- 这里的技术债具体指什么?是因为赶工留下的,还是旧技术选型过时了? -->
## 重构计划
<!-- 你打算如何分步骤进行? -->
## 回归测试说明
<!-- 重构后如何确保原有业务功能不受影响? -->

View File

@@ -0,0 +1,36 @@
---
name: 重要功能提案
about: 提议新特性或重大改进,需详细描述方案
title: "[FEAT]: <提案简述>"
labels: 'type: feature'
assignees: ''
---
## 摘要
<!-- 简单描述这个提案的核心目标 -->
## 动机
<!-- 为什么要添加这个功能?解决了用户什么痛点?如果不加会怎么样? -->
## 目标
<!-- 该提案完成后,应该能实现什么? -->
- [ ]
- [ ]
## 非目标 (可选)
<!-- 明确哪些内容是不属于本次提案范围的,防止需求蔓延 -->
## 提议方案
<!-- 详细描述你的设计思路。如果是 UI 变动,请附带原型图/草图 -->
### 1. 实现细节
<!-- 技术实现上的初步设想 -->
### 2. 破坏性变更
<!-- 是否会影响现有 API 或旧版本兼容性? -->
## 备选方案
<!-- 你是否考虑过其他实现方式?为什么最终选择了当前这一种? -->
## 测试计划
<!-- 如何验证这个功能是否按预期工作?(单元测试、集成测试、手动测试步骤) -->