仓库:issue 表单模板(报告问题 / 功能建议 / 使用疑问);反馈文档补 GitHub Issues 入口

This commit is contained in:
yenharvey
2026-09-13 20:00:05 +08:00
parent b5be1812ab
commit bcb189f4b5
5 changed files with 164 additions and 0 deletions
+84
View File
@@ -0,0 +1,84 @@
name: 报告问题
description: 功能不正常、崩溃、行为与文档不符
title: "[Bug] "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
感谢反馈。请尽量填全,尤其是复现步骤和版本号,能省去来回追问的时间。
提交后维护者会补上平台(`os: *`)与模块(`area: *`)标签,不必自己操心。
- type: dropdown
id: platform
attributes:
label: 平台
options:
- macOS
- Windows
- Linux
validations:
required: true
- type: input
id: os_version
attributes:
label: 系统版本
description: 例如 macOS 26.1、Windows 11 24H2、Windows 10 22H2
placeholder: Windows 11 24H2
validations:
required: true
- type: input
id: qingjian_version
attributes:
label: 青简版本
description: 「设置 → 关于」页里的版本号,或下载的安装包文件名
placeholder: windows-v0.1.0-alpha.2
validations:
required: true
- type: input
id: app
attributes:
label: 出问题时所在的应用
description: 如果只在某些应用里出现,写出应用名和版本;所有应用都出现就写「全部」
placeholder: 企业微信 4.1.x / Visual Studio Code / 全部
- type: dropdown
id: schema
attributes:
label: 输入方案
options:
- 全拼
- 双拼
- 不确定
validations:
required: true
- type: textarea
id: steps
attributes:
label: 复现步骤
description: 一步一步写,包括敲了哪些键。能稳定复现请注明;偶发的也请写大致频率。
placeholder: |
1. 切到青简,在记事本里输入 v1+2
2. 预期出现 3,实际……
validations:
required: true
- type: textarea
id: expected
attributes:
label: 预期行为
validations:
required: true
- type: textarea
id: actual
attributes:
label: 实际行为
description: 可以贴截图或录屏。
validations:
required: true
- type: textarea
id: logs
attributes:
label: 运行日志
description: |
先贴「设置 → 关于 → 复制诊断信息」的内容(版本、系统、配置,密钥会被抹去)。
日志文件:macOS 在「关于 → 打开日志目录」里取当天的;Windows 点「关于 → 打包日志到桌面」,把 zip 拖进来作为附件。
目录位置见 https://qingjian.app/docs/help/data-and-logs 。缺省级别不含输入内容。
render: text
+8
View File
@@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: 使用说明
url: https://qingjian.app/docs
about: 安装、按键总表、双拼、云联想等用法都在这里,提问前可以先查一下。
- name: 数据与日志
url: https://qingjian.app/docs/help/data-and-logs
about: 配置文件、学习数据与运行日志的位置,反馈 bug 时会用到。
@@ -0,0 +1,44 @@
name: 功能建议
description: 希望新增的能力,或现有功能的改进
title: "[Feature] "
labels: ["feature"]
body:
- type: markdown
attributes:
value: |
提建议前可以先搜一下已有 issue,已经有人提过的话在那条下面点个 👍 或补充场景即可,不必重开。
- type: dropdown
id: platform
attributes:
label: 涉及平台
multiple: true
options:
- macOS
- Windows
- Linux
- 全部平台
validations:
required: true
- type: textarea
id: problem
attributes:
label: 想解决什么问题
description: 先说场景和困扰,而不是直接说方案。例如「写代码时经常想不起变量名的英文」。
validations:
required: true
- type: textarea
id: proposal
attributes:
label: 期望的做法
description: 你设想的交互方式,包括按键、设置项、候选的显示方式等。
validations:
required: true
- type: textarea
id: reference
attributes:
label: 其他输入法的参考
description: 如果别的输入法(搜狗、微信、Rime、微软拼音等)已有类似功能,说一下它们怎么做的,有截图更好。
- type: textarea
id: extra
attributes:
label: 补充
+26
View File
@@ -0,0 +1,26 @@
name: 使用疑问
description: 不确定是用法问题还是缺陷,先问一下
title: "[Question] "
labels: ["question"]
body:
- type: markdown
attributes:
value: |
按键总表、双拼、云联想等用法在 [使用说明](https://qingjian.app/docs) 里,很多问题能直接查到。
- type: dropdown
id: platform
attributes:
label: 平台
options:
- macOS
- Windows
- 与平台无关
validations:
required: true
- type: textarea
id: question
attributes:
label: 问题
description: 想做什么、试了什么、结果如何。
validations:
required: true
+2
View File
@@ -4,6 +4,8 @@ order: 3
description: 反馈问题时需提供的材料:当天的日志、「复制诊断信息」的内容,以及常见情况的自查。
---
问题与建议请提到 [GitHub Issues](https://github.com/qingjian-team/qingjian/issues/new/choose),按表单填写即可;表单会要求下面这些材料。
## 反馈时请提供
1. 「偏好设置 → 关于 → 复制诊断信息」:版本、系统、加载的数据、配置原文、日志目录,写入剪贴板。API 密钥会被抹去。