From bcb189f4b561bc4f9633155b6037c8f44db166fe Mon Sep 17 00:00:00 2001 From: yenharvey Date: Sun, 13 Sep 2026 20:00:05 +0800 Subject: [PATCH] =?UTF-8?q?=E4=BB=93=E5=BA=93=EF=BC=9Aissue=20=E8=A1=A8?= =?UTF-8?q?=E5=8D=95=E6=A8=A1=E6=9D=BF=EF=BC=88=E6=8A=A5=E5=91=8A=E9=97=AE?= =?UTF-8?q?=E9=A2=98=20/=20=E5=8A=9F=E8=83=BD=E5=BB=BA=E8=AE=AE=20/=20?= =?UTF-8?q?=E4=BD=BF=E7=94=A8=E7=96=91=E9=97=AE=EF=BC=89=EF=BC=9B=E5=8F=8D?= =?UTF-8?q?=E9=A6=88=E6=96=87=E6=A1=A3=E8=A1=A5=20GitHub=20Issues=20?= =?UTF-8?q?=E5=85=A5=E5=8F=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/ISSUE_TEMPLATE/bug_report.yml | 84 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 +++ .github/ISSUE_TEMPLATE/feature_request.yml | 44 ++++++++++++ .github/ISSUE_TEMPLATE/question.yml | 26 +++++++ docs/user/help/feedback.md | 2 + 5 files changed, 164 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/question.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..d129b04a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..4b594c52 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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 时会用到。 diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..85368c73 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -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: 补充 diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 00000000..8b083dee --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -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 diff --git a/docs/user/help/feedback.md b/docs/user/help/feedback.md index c788adb3..8c8a2b22 100644 --- a/docs/user/help/feedback.md +++ b/docs/user/help/feedback.md @@ -4,6 +4,8 @@ order: 3 description: 反馈问题时需提供的材料：当天的日志、「复制诊断信息」的内容，以及常见情况的自查。 --- +问题与建议请提到 [GitHub Issues](https://github.com/qingjian-team/qingjian/issues/new/choose)，按表单填写即可；表单会要求下面这些材料。 + ## 反馈时请提供 1. 「偏好设置 → 关于 → 复制诊断信息」：版本、系统、加载的数据、配置原文、日志目录，写入剪贴板。API 密钥会被抹去。