From 1cc9edde11b5b3507a09f5021d73de34f8b51ebc Mon Sep 17 00:00:00 2001 From: WhiredPlanck Date: Sat, 13 Jul 2024 10:51:24 +0800 Subject: [PATCH] chore: use form for issue template --- .github/ISSUE_TEMPLATE/bug-report.md | 52 ------------ .github/ISSUE_TEMPLATE/bug_report.yaml | 89 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 4 + .github/ISSUE_TEMPLATE/feature-request.md | 27 ------- .github/ISSUE_TEMPLATE/feature_request.yaml | 61 ++++++++++++++ 5 files changed, 154 insertions(+), 79 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 8c2ea08673..0000000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,52 +0,0 @@ - - ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: bug -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the bug: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See bug - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Log** -If applicable, add crash log to quick focus your problem. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Smartphone (please complete the following information):** - - Device: [e.g. Xiaomi Mix 4] - - OS: [e.g. Android 11] - - Theme: [e.g. Tongwenfeng] - - Version: [e.g. 3.2.1] - - Build info: - ``` - You could find build info in About Activity and click it to copy. - e.g. - Build: Commit CI - Date: 2022-06-12 10:09 UTC - Commit: v3.2.6-58-gd9b4c1f, 2022-06-12 17:58:14 +0800 - Branch: develop - Repository: https://github.com/osfans/trime - ``` -**Additional context** -Add any other context about the problem here. - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 0000000000..03761bac3a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,89 @@ +# SPDX-FileCopyrightText: 2015 - 2024 Rime community +# +# SPDX-License-Identifier: GPL-3.0-or-later + +name: 问题报告 / Bug Report +description: 创建问题报告以帮助我们改进。 / Create a bug report to help us improve. +labels: + - bug + +body: + - type: textarea + id: summary + attributes: + label: 摘要 / Summary + description: 简要描述遇到的问题。请先测试[每夜版](https://github.com/osfans/trime/releases/tag/nightly)有无此问题。 / Briefly describe the bug. Test [Nightly](https://github.com/osfans/trime/releases/tag/nightly) for the bug first. + validations: + required: true + + - type: textarea + id: step_to_reproduce + attributes: + label: 重现步骤 / Steps to Reproduce + description: 如何重现该问题。 / How to reproduce the bug. + placeholder: | + 1. 打开某界面 / Open page ... + 2. 点击某菜单 / Click menu ... + 3. 某处出问题 / Something went wrong ... + validations: + required: true + + - type: textarea + id: expected_behavior + attributes: + label: 预期行为 / Expected Behavior + description: 完成上述步骤后应该发生什么。 / What is expected to happen after the steps above. + validations: + required: true + + - type: textarea + id: log + attributes: + label: 日志 / Log + description: 附上日志以帮助定位问题。 / Attach log to help locate the bug. + validations: + required: false + + - type: textarea + id: screenshot + attributes: + label: 截图 / Screenshot + description: 附上截图以帮助解释问题。 / Attach screenshots to help explain the bug. + validations: + required: false + + - type: textarea + id: additional_context + attributes: + label: 附加信息 / Additional Context + description: 与此问题相关的上下文信息，比如在问题出现前做了什么、使用了什么主题等。 / Additional context about the bug, eg. what did you do before the bug appears or what theme you are using, etc. + validations: + required: false + + - type: markdown + attributes: + value: | + ### 设备信息 / Device Infomation + + - type: input + id: os_version + attributes: + label: 系统版本 / OS Version + validations: + required: true + + - type: input + id: app_version + attributes: + label: 应用版本 / App Version + description: “关于”页面中的“更新日志”条目，长按复制。 / It could be found below "Changelog" in the "About" page, long press to copy it. + validations: + required: true + + - type: textarea + id: build_info + attributes: + label: 构建信息 / Build Information + description: “关于”页面中的“构建信息”条目，长按复制。 / It could be found below "Build information" in the "About" page, loog press to copy it. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index bb3aade6c9..ccde94a651 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -4,3 +4,7 @@ blank_issues_enabled: false +contact_links: + - name: GitHub 讨论区 / GitHub Discussions + url: https://github.com/osfans/trime/discussions + about: 请在这里提出有关如何使用本输入法的疑问。 / Please ask questions about how to use the input method here. diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index 3b5eb9fa15..0000000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,27 +0,0 @@ - - ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: enhancement -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. - diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 0000000000..e9c6a81084 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,61 @@ +# SPDX-FileCopyrightText: 2015 - 2024 Rime community +# +# SPDX-License-Identifier: GPL-3.0-or-later + +name: 功能请求 / Feature Request +description: 为本项目提供新功能建议 / Suggest a new feature for this project +labels: + - enhancement + +body: + - type: textarea + id: summary + attributes: + label: 摘要 / Summary + description: 新功能应该做什么。 / What the new feature should do. + validations: + required: true + + - type: textarea + id: alternative + attributes: + label: 替代方案 / Alternative Solution + description: 其它可能的解决方案（如果有）。 / Other possible solutions, if any. + validations: + required: false + + - type: textarea + id: additional_context + attributes: + label: 附加信息 / Additional Context + description: 与此功能请求有关的上下文信息或截图。 / Additional context or screenshots about the feature request. + validations: + required: false + + - type: markdown + attributes: + value: | + ### 设备信息 / Device Infomation + + - type: input + id: os_version + attributes: + label: 系统版本 / OS Version + validations: + required: true + + - type: input + id: app_version + attributes: + label: 应用版本 / App Version + description: “关于”页面中的“更新日志”条目，长按复制。 / It could be found below "Changelog" in the "About" page, long press to copy it. + validations: + required: true + + - type: textarea + id: build_info + attributes: + label: 构建信息 / Build Information + description: “关于”页面中的“构建信息”条目，长按复制。 / It could be found below "Build information" in the "About" page, loog press to copy it. + validations: + required: true