Skip to content

Commit

Permalink
chore: add issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
mirtlecn committed Sep 12, 2024
1 parent fc1cf8f commit 1a3a57d
Show file tree
Hide file tree
Showing 3 changed files with 141 additions and 0 deletions.
76 changes: 76 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
name: Bug 报告
description: 我遇到了一个 bug 或是非预期行为
title: '[Bug]: '
labels:
- bug
body:
- type: input
id: input
attributes:
label: 摘要
description: 一两句话概述遇到的问题
validations:
required: true
- type: checkboxes
id: check_box
attributes:
label: 基本检查
description: 如实勾选相关选项,以提高沟通的效率
options:
- label: 我使用的是雾凇拼音 iDvel/rime-ice
required: true
- label: 我搜索了过往的 issue,没找到解决办法
required: true
- label: 我查看了置顶 issue 和详细介绍,没找到解决办法
required: true
- label: 不对雾凇拼音进行任何修改,也会有这个问题
required: false
- label: 雾凇拼音最新 commit 或 Nightly 版,仍然有这个问题
required: false
- label: 我知晓:如果此 issue 不符合模板,或者长时间不活跃,会被无条件关闭
required: true
- type: input
id: os_version
attributes:
label: 系统信息
description: 请提供你能复现此问题的系统名称,以及版本号
placeholder: macOS 14.5 / Windows 11 23H2 / Ubuntu 22.04 LTS
validations:
required: true
- type: input
id: app_version
attributes:
label: 应用信息
description: 提供你使用的 RIME 前端和版本号,自构建前端请说明
placeholder: Squirrel 1.0.2 / Weasel 0.16.1
validations:
required: true
- type: textarea
id: step_to_reproduce
attributes:
label: 复现办法和预期行为
description: 重现该问题的办法,雾凇在你预期中应当如何行为
value: |
1.
2.
validations:
required: true
- type: textarea
id: info
attributes:
label: '补充信息'
description: ' 请提供你认为重要的其他信息,例如截图、视频、Rime 的报错信息等'
- type: textarea
id: config
attributes:
label: 自定义配置
description: 如果你对雾凇进行了修改或者打了补丁,请在此处提供你的自定义配置
placeholder: |
完整配置文件请压缩上传。
配置片段请包裹在 Markdown 代码块中。即用三个反引号(```)包裹,如
```yaml
# 你的配置片段
```
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
blank_issues_enabled: false

contact_links:
- name: 词库问题
url: https://github.com/iDvel/rime-ice/issues/666
about: 如果你发现了词库中有字词音形有错讹、缺漏等情况,请直接在这个链接中评论。鼓励你直接 PR,参与雾凇的维护。

- name: 雾凇拼音详细介绍
url: https://dvel.me/posts/rime-ice/
about: 这里是雾凇拼音的详细介绍,包括了安装、配置、使用和配置思路等内容。

- name: 雾凇拼音常见问题
url: https://github.com/iDvel/rime-ice/issues/133
about: 这里有一些重要问题的答案,提问前请查看,也请事先搜索 issue,你的问题也许已经有现成的答案。

- name: RIME 定制文档
url: https://github.com/rime/home/wiki
about: 这里有自定义 RIME 方案的全面教程。

- name: 小狼毫(Weasel)文档
url: https://github.com/rime/weasel/wiki
about: 这里有定制 Weasel 样式和行为的指导。

- name: 鼠须管(Squirrel)文档
url: https://github.com/LEOYoon-Tsaw/Rime_collections/blob/master/鼠鬚管介面配置指南.md
about: 这里有定制 Squirrel 样式和行为的参考资料。
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/others.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: 想法、求助和提议
description: 我有一些想法和建议;或是一些不理解的地方想要求助
title: '请问:'

body:
- type: input
id: summary
attributes:
label: 摘要
description: 用一两句话概括此 issue 的内容
validations:
required: true
- type: input
id: app_version
attributes:
label: 应用信息
description: 如果必要,请提供你使用的 RIME 前端和版本号
placeholder: 例如:Squirrel 1.0.2 / Fcitx5 for Android 0.9 / Weasel 15.0
validations:
required: false
- type: textarea
id: content
attributes:
label: 详细说明
description: 请详细说明你的问题或者想法,越具体越好。
validations:
required: true
- type: textarea
id: config
attributes:
label: 补充信息
description: 如果必要,在此处提供你的自定义配置片段或完整配置、脚本文件
placeholder: |
完整配置文件请压缩上传。
配置片段请包裹在 Markdown 代码块中。即用三个反引号(```)包裹,如
```yaml
# 你的配置片段
```

0 comments on commit 1a3a57d

Please sign in to comment.