chore: 创建Issue模板 #13

Manually merged
remilia merged 2 commits from chore/template into master 2025-09-17 17:17:20 +08:00
3 changed files with 117 additions and 11 deletions

View File

@ -0,0 +1,61 @@
name: Bug报告
about: 用于报告项目中的Bug帮助我们改进项目
title: "[BUG] " # 新开 Issue 时默认加的前缀
body:
- type: markdown
attributes:
value: |
请在下方填写Bug的详细信息包括重现步骤、预期结果和实际结果等。
- type: textarea
id: summary
attributes:
label: "问题概述/Summary"
description: "简要描述遇到的问题"
placeholder: "输入问题概述"
validations:
required: true
- type: textarea
id: steps
attributes:
label: "重现步骤/Steps to Reproduce"
description: "列出重现该问题的具体步骤"
placeholder: "输入重现步骤"
validations:
required: true
- type: textarea
id: expected
attributes:
label: "预期结果/Expected Behavior"
description: "描述你期望看到的结果"
placeholder: "输入预期结果"
validations:
required: true
- type: textarea
id: actual
attributes:
label: "实际结果/Actual Behavior"
description: "描述实际发生的情况"
placeholder: "输入实际结果"
validations:
required: true
- type: textarea
id: environment
attributes:
label: "环境信息/Environment"
description: "提供相关环境信息,如操作系统、浏览器版本等"
placeholder: "输入环境信息"
validations:
required: false
- type: checkboxes
id: checklist
attributes:
label: "检查表/Checklist"
description: "提交前,请确认以下事项"
options:
- label: 已搜索过类似问题,确保不是重复报告
required: true
- label: 提供了足够的信息以帮助我们理解和重现问题
required: true
- label: 如果可能,已附上相关截图或日志文件
required: false

View File

@ -0,0 +1,53 @@
name: 功能请求
about: 用于提出新功能或改进建议
title: "[FEATURE] " # 新开 Issue 时默认加的前缀
body:
- type: markdown
attributes:
value: |
请在下方填写功能请求的详细信息,包括需求背景、预期效果和相关上下文。
- type: textarea
id: summary
attributes:
label: "功能概述/Summary"
description: "简要描述你希望添加的功能"
placeholder: "输入功能概述"
validations:
required: true
- type: textarea
id: motivation
attributes:
label: "需求背景/Motivation"
description: "说明为什么需要这个功能,它将如何帮助用户或改进现有流程"
placeholder: "输入需求背景"
validations:
required: true
- type: textarea
id: proposal
attributes:
label: "解决方案/Proposal"
description: "描述你对该功能的设想或建议的实现方式"
placeholder: "输入解决方案"
validations:
required: false
- type: textarea
id: alternatives
attributes:
label: "替代方案/Alternatives"
description: "如果有其他可行的替代方案,请在此列出"
placeholder: "输入替代方案"
validations:
required: false
- type: checkboxes
id: checklist
attributes:
label: "检查表/Checklist"
description: "提交前,请确认以下事项"
options:
- label: 已搜索过类似功能请求,确保不是重复提交
required: true
- label: 提供了足够的信息以帮助我们理解和评估该请求
required: true
- label: 如果可能,已附上相关截图或示意图
required: false

View File

@ -9,7 +9,6 @@ body:
value: | value: |
请在下方填写合并请求描述,包括变更目的、主要内容及相关上下文。 请在下方填写合并请求描述,包括变更目的、主要内容及相关上下文。
- type: textarea - type: textarea
id: issue
attributes: attributes:
label: "关联Issue" label: "关联Issue"
description: "比如: Fixes #123/Closes #456/如果没有可以留空" description: "比如: Fixes #123/Closes #456/如果没有可以留空"
@ -17,25 +16,20 @@ body:
validations: validations:
required: false required: false
- type: textarea - type: textarea
id: changes
attributes: attributes:
label: "更改内容/What Changed" label: "更改内容/What Changed"
description: "列出本次 PR 的主要变更项,便于 Review" description: "列出本次 PR 的主要变更项,便于 Review"
placeholder: "输入更改内容" placeholder: "输入更改内容"
value: ""
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: test
attributes: attributes:
label: "测试步骤/How To Test" label: "测试步骤/How To Test"
description: "提供复现/验证更改的步骤,含环境/命令/预期结果等" description: "提供复现/验证更改的步骤,含环境/命令/预期结果等"
placeholder: "输入测试步骤" placeholder: "输入测试步骤"
value: ""
validations: validations:
required: false required: false
- type: checkboxes - type: checkboxes
id: checklist
attributes: attributes:
label: "检查表/Checklist" label: "检查表/Checklist"
description: "提交前,请确认以下事项" description: "提交前,请确认以下事项"
@ -60,10 +54,8 @@ body:
label: "影响评估/Risk & Rollback" label: "影响评估/Risk & Rollback"
description: "评估变更是否有破坏性风险,以及如何回滚/缓解" description: "评估变更是否有破坏性风险,以及如何回滚/缓解"
placeholder: "例如:数据库迁移、依赖变动、兼容性问题等" placeholder: "例如:数据库迁移、依赖变动、兼容性问题等"
value: ""
validations: validations:
required: false required: false
- type: markdown - type: textarea
attributes: label: "可选:截图或 Demo(如界面/UI 有变化)"
value: |
**可选:截图或 Demo(如界面/UI 有变化)**