From e79d862256ed572317ce78204c2630fb3157ff53 Mon Sep 17 00:00:00 2001 From: Fu Diwei Date: Mon, 24 Mar 2025 20:55:06 +0800 Subject: [PATCH] chore: github issue templates --- .github/ISSUE_TEMPLATE/1-bug_report.yml | 77 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/2-feature_request.yml | 56 ++++++++++++++ .github/ISSUE_TEMPLATE/3-questions.yml | 40 ++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 33 --------- .github/ISSUE_TEMPLATE/config.yml | 9 ++- .github/ISSUE_TEMPLATE/feature_request.md | 19 ----- 6 files changed, 179 insertions(+), 55 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/1-bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/2-feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/3-questions.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/1-bug_report.yml b/.github/ISSUE_TEMPLATE/1-bug_report.yml new file mode 100644 index 00000000..807c96fc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-bug_report.yml @@ -0,0 +1,77 @@ +name: "🐞 Bug Report" +description: "报告缺陷来帮助我们完善 / Create a report to help us improve." +title: "[Bug] 简要描述你发现的缺陷" +labels: + - bug +body: + - type: markdown + attributes: + value: | + ## Welcome! + + **在提交 Issue 之前,请确认以下事项**: + 1. 我**确认**已尝试使用是当前最新版本,并能复现问题。 + 2. 我**确认**已搜索过[已有的 Issues](https://github.com/usual2970/certimate/issues)(包括已关闭的),没有类似的问题。 + 3. 我**确认**已阅读过[文档](https://docs.certimate.me/),没有类似的问题。 + 4. 请**务必**按照模板规范详细描述问题,否则 Issue 将会被直接关闭。 + + **Before you submit the issue, please make sure of the following checklist**: + 1. Yes, I'm using the latest release and can reproduce the issue. + 2. Yes, I've searched for [existing issues](https://github.com/usual2970/certimate/issues) (including closed ones) on GitHub and didn't find any similar. + 3. Yes, I've read the [documentation](https://docs.certimate.me/en/) and didn't find any similar. + 4. Please describe the problem in detail according to the template specification, otherwise the issue will be closed directly. + + - type: input + attributes: + label: 软件版本 / Release Version + description: 请提供 Certimate 的具体版本。 / Please provide the specific version of Certimate. + placeholder: (e.g. v1.0.0) + validations: + required: true + + - type: textarea + attributes: + label: 缺陷描述 / Description + description: 请详细清晰地描述你发现的缺陷或故障,如果可能请上传截图。 / Describe the bug you found in detail and clearly, and upload screenshots if possible. + validations: + required: true + + - type: textarea + attributes: + label: 复现步骤 / Steps to reproduce + description: 请提供可复现的完整步骤。 / Please walk us through it step by step. + placeholder: | + 1. ... + 2. ... + 3. ... + ... + validations: + required: true + + - type: textarea + attributes: + label: 日志 / Logs + description: 在此处添加日志信息(如果有的话)。 / Add logs here if available. + value: |- +
+ + ```console + # 请在此粘贴日志 / Paste logs here + ``` + +
+ validations: + required: false + + - type: textarea + attributes: + label: 其他 / Miscellaneous + description: 在此处添加关于该 Issue 的任何其他信息。 / Add any other context about the issue here. + validations: + required: false + + - type: markdown + attributes: + value: | + 请保持每个 Issue 只包含一个缺陷报告。 + Please limit one report per issue. diff --git a/.github/ISSUE_TEMPLATE/2-feature_request.yml b/.github/ISSUE_TEMPLATE/2-feature_request.yml new file mode 100644 index 00000000..a7c82959 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-feature_request.yml @@ -0,0 +1,56 @@ +name: "💡 Feature Request" +description: "提出新功能请求或改进意见 / Suggest an idea for this project." +title: "[Feature] 简要描述你希望实现的功能" +labels: + - enhancement +body: + - type: markdown + attributes: + value: | + ## Welcome! + + **在提交 Issue 之前,请确认以下事项**: + 1. 我**确认**是基于当前最新大版本而提出的新功能请求或改进意见。 + 2. 我**确认**已搜索过[已有的 Issues](https://github.com/usual2970/certimate/issues)(包括已关闭的),没有类似的问题。 + 3. 我**确认**已阅读过[文档](https://docs.certimate.me/),没有类似的问题。 + 4. 请**务必**按照模板规范详细描述问题,否则 Issue 将会被直接关闭。 + + **Before you submit the issue, please make sure of the following checklist**: + 1. Yes, I'm using the latest release. + 2. Yes, I've searched for [existing issues](https://github.com/usual2970/certimate/issues) (including closed ones) on GitHub and didn't find any similar. + 3. Yes, I've read the [documentation](https://docs.certimate.me/en/) and didn't find any similar. + 4. Please describe the problem in detail according to the template specification, otherwise the issue will be closed directly. + + - type: textarea + attributes: + label: 功能描述 / Description + description: 请详细清晰地描述你希望添加的功能,如果可能请上传截图。 / Describe the feature you'd like to add in detail and clearly, and upload screenshots if possible. + validations: + required: true + + - type: textarea + attributes: + label: 请求动机 / Motivation + description: 为什么这个功能对项目有帮助? / Why is this feature helpful to the project? + validations: + required: true + + - type: textarea + attributes: + label: 其他 / Miscellaneous + description: 在此处添加关于该 Issue 的任何其他信息。 / Add any other context about the problem here. + validations: + required: false + + - type: checkboxes + attributes: + label: 贡献 / Contribution + options: + - label: 我乐意为此贡献代码! / I am interested in contributing to this feature! + required: false + + - type: markdown + attributes: + value: | + 请保持每个 Issue 只包含一个功能请求。 + Please limit one request per issue. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/3-questions.yml b/.github/ISSUE_TEMPLATE/3-questions.yml new file mode 100644 index 00000000..fd847486 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-questions.yml @@ -0,0 +1,40 @@ +name: "❓ Questions" +description: "遇到了困难需要求助? / Have problem in use and need help?" +title: "[Feature] 简要描述你遇到的问题" +body: + - type: markdown + attributes: + value: | + ## Welcome! + + **在提交 Issue 之前,请确认以下事项**: + 1. 我**确认**正在使用的是当前最新版本。 + 2. 我**确认**已搜索过[已有的 Issues](https://github.com/usual2970/certimate/issues)(包括已关闭的),没有类似的问题。 + 3. 我**确认**已阅读过[文档](https://docs.certimate.me/),没有类似的问题。 + 4. 请**务必**按照模板规范详细描述问题,否则 Issue 将会被直接关闭。 + + **Before you submit the issue, please make sure of the following checklist**: + 1. Yes, I'm using the latest release. + 2. Yes, I've searched for [existing issues](https://github.com/usual2970/certimate/issues) (including closed ones) on GitHub and didn't find any similar. + 3. Yes, I've read the [documentation](https://docs.certimate.me/en/) and didn't find any similar. + 4. Please describe the problem in detail according to the template specification, otherwise the issue will be closed directly. + + - type: textarea + attributes: + label: 问题描述 / Description + description: 请详细清晰地描述你遇到的问题,如果可能请上传截图。 / Describe the problem you encountered in detail and clearly, and upload screenshots if possible. + validations: + required: true + + - type: textarea + attributes: + label: 其他 / Miscellaneous + description: 在此处添加关于该问题的任何其他信息。 / Add any other context about the problem here. + validations: + required: false + + - type: markdown + attributes: + value: | + 请保持每个 Issue 只包含一个问题求助。 + Please limit one question per issue. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 52494864..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: Bug report -about: 创建一个报告来帮助我们改进 -title: "[Bug] 标题简要描述问题" -labels: bug -assignees: "" ---- - -**描述问题** -简要描述问题是什么,1 个 ISSUE 只描述一个问题。 - -**复现步骤** -复现该问题的步骤: - -1. 去到 '...' -2. 点击 '...' -3. 滚动到 '...' -4. 发现问题 - -**期望的结果** -简要描述你期望发生的事情。 - -**截图** -如有可能,请添加截图以帮助解释问题。 - -**环境** - -- 操作系统: [e.g. Windows, macOS] -- 浏览器: [e.g. Chrome, Safari] -- 仓库版本: [e.g. v1.0.0] - -**其他信息** -在此处添加关于该问题的任何其他信息。 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index bc6bb57b..32e80fce 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,8 @@ blank_issues_enabled: false contact_links: - - name: 加入频道讨论 - url: https://t.me/+ZXphsppxUg41YmVl - about: 加入到电报频道寻求更多帮助 + - name: "🌐 加入频道讨论" + about: "加入到电报频道寻求更多帮助。 / Join in our Telegram channel." + url: "https://t.me/+ZXphsppxUg41YmVl" + - name: "📖 常见问题" + about: "请先阅读文档 FAQ,可能会有你需要的答案。 / Please take a look to FAQs." + url: "https://docs.certimate.me/docs/reference/faq" diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 9eb598c9..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: Feature request -about: 提出一个新功能请求 -title: "[Feature] 简要描述你希望实现的功能" -labels: enhancement -assignees: "" ---- - -**功能描述** -简要描述你希望添加的功能和相关问题,1 个 ISSUE 只描述一个功能。 - -**动机** -为什么这个功能对项目有帮助? - -**替代方案** -描述你已经考虑过的替代方案。 - -**其他信息** -在这里添加任何相关的附加信息或截图。