Merge pull request #469 from hicccc77/dev

细化issue模板
This commit is contained in:
cc
2026-03-16 21:36:45 +08:00
committed by GitHub
6 changed files with 268 additions and 50 deletions

View File

@@ -1,59 +1,103 @@
name: " 报告 Bug" name: "报告 Bug"
description: "代码出现了非预期的问题、崩溃或报错" description: "代码出现了非预期的问题、崩溃或报错"
title: "[Bug]: " title: "[Bug]: "
labels: ["type: bug"] labels: ["type: bug", "status: needs info"]
body: body:
- type: markdown - type: markdown
attributes: attributes:
value: | value: |
请提供尽可能多的细节,这将帮助我们更快定位 `type: bug` 请提供尽可能详细的信息,帮助我们快速定位和修复问题
- type: checkboxes - type: checkboxes
id: pre-check id: pre-check
attributes: attributes:
label: 提交前自测 label: 提交前确认
description: 请务必确认以下事项 description: 请务必确认以下事项
options: options:
- label: 我已经查阅了文档,并且搜索过现有的 Issues确认这不是一个重复问题 - label: 我已搜索过现有的 Issues确认这不是重复问题
required: true required: true
- label: 我使用的是当前最新版本 - label: 我使用的是最新版本
required: true required: true
- label: 我已阅读过相关文档
required: true
- type: dropdown
id: severity
attributes:
label: 问题严重程度
description: 这个问题对你的使用造成了多大影响?
options:
- 严重崩溃或数据丢失(无法使用)
- 核心功能受影响(在下一个常规发布中必须修复)
- 边缘场景或轻微问题(等待空闲时修复)
validations:
required: true
- type: textarea - type: textarea
id: description id: description
attributes: attributes:
label: 问题描述 label: 问题描述
description: 清晰、明确地描述你遇到了什么问题。 description: 清晰描述你遇到的问题,包括实际发生了什么
placeholder: 当我执行...操作时,程序崩溃了,或者输出了不正确的结果... placeholder: 例如:当我点击发送按钮时,应用程序崩溃并显示白屏
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: reproduction id: reproduction
attributes: attributes:
label: 复现步骤 label: 复现步骤
description: 提供精确的步骤,帮助我们复现该问题。如果可能,请提供最小复现代码协助我们的定位问题 description: 提供详细的操作步骤,让我们能够重现这个问题
placeholder: | placeholder: |
1. 运行命令 '...' 1. 打开应用并登录账号
2. 点击 '...' 2. 进入聊天页面
3. 发现问题 '...' 3. 点击发送按钮
4. 观察到应用崩溃
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: expected-behavior id: expected-behavior
attributes: attributes:
label: 预期行为 label: 预期行为
description: 你期望看到什么结果? description: 描述你期望的正确行为应该是什么样的
placeholder: 程序应该正常输出...而不是崩溃。 placeholder: 例如:点击发送按钮后,消息应该正常发送并显示在聊天窗口中
validations:
required: true
- type: textarea
id: actual-behavior
attributes:
label: 实际行为
description: 描述实际发生的错误行为
placeholder: 例如:点击后应用直接崩溃,显示白屏
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: logs id: logs
attributes: attributes:
label: 错日志或截图 label: 日志或截图
description: 请提供终端报错信息、浏览器 Console 日志,或直接将截图拖入此处。 description: 粘贴控制台错误信息、崩溃日志,或拖入截图
placeholder: 请粘贴完整的错误堆栈信息
render: shell render: shell
- type: input - type: input
id: environment id: os
attributes: attributes:
label: 运行环境 label: 操作系统
description: 你的操作系统、软件版本、依赖环境、系统架构等Windows 11, Node v18.16.0 description: 例如Windows 11、macOS 14.2、Ubuntu 22.04
placeholder: Windows 11
validations: validations:
required: true required: true
- type: input
id: app-version
attributes:
label: 应用版本
description: 在关于页面或设置中查看版本号
placeholder: v1.2.3
validations:
required: true
- type: input
id: architecture
attributes:
label: 系统架构
description: 例如x64、arm64
placeholder: x64
- type: textarea
id: additional-context
attributes:
label: 补充信息
description: 其他可能有助于定位问题的信息
placeholder: 例如:这个问题是在某次更新后开始出现的,或者只在特定网络环境下出现

View File

@@ -1,4 +1,4 @@
blank_issues_enabled: false blank_issues_enabled: false
contact_links: contact_links:
- name: 🤔 找不到合适的模板? - name:🤔 找不到合适的模板?
about: 如果你只是想闲聊或者你的问题不属于上述任何分类,请前往我们的Telegram频道与我们交流。 about: 如果你的问题不属于上述任何分类,请前往我们的 Telegram 频道与我们交流。

View File

@@ -1,4 +1,4 @@
name: " 文档反馈" name: "文档反馈"
description: "文档存在错别字、描述不清晰或缺少必要的示例" description: "文档存在错别字、描述不清晰或缺少必要的示例"
title: "[Docs]: " title: "[Docs]: "
labels: ["type: docs"] labels: ["type: docs"]
@@ -7,18 +7,61 @@ body:
attributes: attributes:
value: | value: |
优秀的文档和代码一样重要。感谢你帮助我们完善文档! 优秀的文档和代码一样重要。感谢你帮助我们完善文档!
- type: dropdown
id: doc-type
attributes:
label: 文档类型
description: 问题出现在哪类文档中?
options:
- README 或项目说明
- 安装部署文档
- 使用教程
- API 文档
- 开发者文档
- 其他
validations:
required: true
- type: input - type: input
id: doc-link id: doc-link
attributes: attributes:
label: 相关文档链接 label: 文档位置
description: 提供存在问题的文档 URL 或具体文件路径 description: 提供文档 URL 或文件路径
placeholder: 例如docs/installation.md 或 https://github.com/xxx/xxx/wiki/xxx
validations:
required: true
- type: dropdown
id: issue-type
attributes:
label: 问题类型
description: 文档存在什么问题?
options:
- 错别字或语法错误
- 内容过时或不准确
- 描述不清晰或有歧义
- 缺少必要的示例代码
- 缺少重要的说明或警告
- 链接失效或错误
- 其他
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: issue-desc id: issue-desc
attributes: attributes:
label: 问题描述与建议 label: 问题描述
description: 文档哪里写错了?或者你建议补充什么内容? description: 详细说明文档中存在的问题
placeholder: 在 "快速开始" 章节中,第三步的命令拼写错误,应该改为... placeholder: 例如:第 3 步中的命令拼写错误,应该是 "npm install" 而不是 "npm instal"
validations: validations:
required: true required: true
- type: textarea
id: suggestion
attributes:
label: 修改建议
description: 你认为应该如何修改?
placeholder: 例如:建议将"安装依赖"部分补充完整的命令示例,并说明不同操作系统的差异
validations:
required: true
- type: textarea
id: additional
attributes:
label: 补充说明
description: 其他需要补充的信息

View File

@@ -7,19 +7,72 @@ body:
attributes: attributes:
value: | value: |
持续优化是项目进步的动力!请告诉我们哪个现有功能可以做得更好。 持续优化是项目进步的动力!请告诉我们哪个现有功能可以做得更好。
- type: checkboxes
id: pre-check
attributes:
label: 提交前确认
options:
- label: 我已搜索过现有的 Issues确认这个优化建议尚未被提出
required: true
- label: 这是对现有功能的改进,而不是全新功能
required: true
- type: dropdown
id: category
attributes:
label: 优化类别
description: 这个优化主要属于哪个方面?
options:
- 性能优化(速度、内存、资源占用)
- 交互体验(操作流程、界面布局)
- 视觉设计(样式、动画、美观度)
- 易用性(降低使用门槛、减少操作步骤)
- 稳定性(减少崩溃、提高可靠性)
- 其他
validations:
required: true
- type: textarea - type: textarea
id: target id: target
attributes: attributes:
label: 目标功能 label: 目标功能或模块
description: 你希望优化的功能或模块是哪个? description: 你希望优化的具体功能或页面是哪个?
placeholder: 例如:当前的导出功能 / 某个页面的交互... placeholder: 例如:聊天页面的消息加载、设置页面的布局、文件上传功能
validations:
required: true
- type: textarea
id: current-behavior
attributes:
label: 当前表现
description: 描述当前功能的不足之处或存在的问题
placeholder: 例如:消息列表滚动时会出现明显卡顿,加载 100 条消息需要 3 秒
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: improvement id: improvement
attributes: attributes:
label: 优化建议 label: 优化建议
description: 你认为应该怎么改?这会带来什么好处(如:性能提升、减少点击次数、视觉更美观)? description: 详细说明你的优化方案和预期效果
placeholder: 我建议将...改成...,这样可以将处理速度提升一倍。 placeholder: 例如:建议使用虚拟滚动技术,只渲染可见区域的消息,预计可将加载时间缩短到 0.5 秒以内
validations:
required: true
- type: textarea
id: benefits
attributes:
label: 优化收益
description: 这个优化会带来什么具体好处?
placeholder: 例如:提升 80% 的加载速度、减少 50% 的内存占用、降低用户操作步骤从 5 步到 2 步
validations:
required: true
- type: textarea
id: impact
attributes:
label: 影响范围
description: 这个优化会影响哪些用户或场景?
placeholder: 例如:所有用户在查看历史消息时都会受益,尤其是群聊消息较多的场景
- type: checkboxes
id: contribution
attributes:
label: 参与贡献
options:
- label: 我愿意提交 Pull Request 来实现这个优化
validations: validations:
required: true required: true

View File

@@ -6,30 +6,66 @@ body:
- type: markdown - type: markdown
attributes: attributes:
value: | value: |
感谢你为项目提供新想法!详细的需求描述能极大地增加该功能被采纳的几率。 感谢你为项目提供新想法!详细的需求描述能极大提高该功能被采纳的几率。
- type: textarea - type: checkboxes
id: motivation id: pre-check
attributes: attributes:
label: 需求背景 / 动机 label: 提交前确认
description: 为什么需要这个功能?你目前遇到了什么痛点? options:
placeholder: 目前我在做...事情时,必须手动处理,非常不方便。如果能有...功能就太好了。 - label: 我已搜索过现有的 Issues 和 Pull Requests确认这个功能尚未被提出或实现
required: true
- label: 这是一个全新的功能,而不是对现有功能的改进
required: true
- type: dropdown
id: priority
attributes:
label: 功能优先级
description: 你认为这个功能有多重要?
options:
- 高优先级(核心功能缺失,严重影响使用体验)
- 中优先级(有助于提升使用体验)
- 低优先级(锦上添花的功能)
validations:
required: true
- type: textarea
id: problem
attributes:
label: 问题或痛点
description: 描述你当前遇到的问题或不便之处
placeholder: 例如:目前无法批量导出聊天记录,每次只能手动复制单条消息,非常耗时
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: solution id: solution
attributes: attributes:
label: 期望的解决方案 label: 期望的解决方案
description: 详细描述你希望这个新功能是什么样的,它是如何工作的 description: 详细描述你希望的功能是如何工作的
placeholder: 例如:希望能在聊天窗口右键菜单中添加"导出聊天记录"选项支持选择时间范围和导出格式TXT/JSON
validations:
required: true
- type: textarea
id: use-case
attributes:
label: 使用场景
description: 描述这个功能的典型使用场景
placeholder: 例如:工作中需要定期备份重要的项目讨论记录,或者需要将聊天内容整理成文档
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: alternatives id: alternatives
attributes: attributes:
label: 备选方案 (可选) label: 替代方案
description: 你目前使用什么临时的替代方案?或者有没有考虑过其他实现方式? description: 你目前使用什么临时方案?或者有没有考虑过其他实现方式?
placeholder: 例如:目前只能手动截图或逐条复制粘贴
- type: textarea
id: reference
attributes:
label: 参考示例
description: 其他应用中是否有类似功能可以参考?
placeholder: 例如微信的聊天记录导出功能、Telegram 的导出数据功能
- type: checkboxes - type: checkboxes
id: help-wanted id: contribution
attributes: attributes:
label: 参与贡献 label: 参与贡献
options: options:
- label: 有能力且愿意提交 Pull Request 来实现这个功能(我们会为你打上 `help wanted` 标签) - label: 我愿意提交 Pull Request 来实现这个功能

View File

@@ -7,23 +7,65 @@ body:
attributes: attributes:
value: | value: |
在提问之前,请确保你已经仔细阅读过我们的官方文档。 在提问之前,请确保你已经仔细阅读过我们的官方文档。
- type: checkboxes
id: pre-check
attributes:
label: 提交前确认
options:
- label: 我已阅读过相关文档
required: true
- label: 我已搜索过现有的 Issues没有找到类似问题
required: true
- type: dropdown
id: question-type
attributes:
label: 问题类型
description: 你的问题属于哪个方面?
options:
- 安装部署问题
- 配置相关问题
- 功能使用问题
- API 调用问题
- 错误排查问题
- 其他
validations:
required: true
- type: textarea - type: textarea
id: question id: question
attributes: attributes:
label: 你的问题是什么? label: 问题描述
description: 清晰描述你疑问 description: 清晰描述你遇到的问题或疑问
placeholder: 例如:我在 Windows 系统上安装后无法启动应用,双击图标没有任何反应
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: attempts id: attempts
attributes: attributes:
label: 你做过哪些尝试? label: 已尝试的方法
description: 请告诉我们你已经试过了什么方法,避免我们提供重复的建议。 description: 你已经试过哪些解决方法?
placeholder: 例如:我尝试过重新安装、以管理员身份运行、关闭防火墙,但问题依然存在
validations:
required: true
- type: textarea
id: environment
attributes:
label: 运行环境
description: 提供你的系统环境信息
placeholder: |
操作系统Windows 11
应用版本v1.2.3
系统架构x64
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: code-snippet id: code-snippet
attributes: attributes:
label: 相关代码配置 label: 相关配置或代码
description: 请粘贴你当前的配置文件或调用的代码片段。 description: 如果涉及配置或代码问题,请粘贴相关内容
placeholder: 粘贴你的配置文件或代码片段
render: javascript render: javascript
- type: textarea
id: screenshots
attributes:
label: 截图或日志
description: 如有必要,请提供截图或错误日志