From 1b30a75317766ddb70ada920bf3fd7d04a326401 Mon Sep 17 00:00:00 2001 From: KT-Yeh <> Date: Sun, 20 Oct 2024 06:42:39 +0800 Subject: [PATCH] chore: update issue template --- .github/ISSUE_TEMPLATE/bug_report.yml | 22 ++++++----- .github/ISSUE_TEMPLATE/bug_report_zh.yml | 18 +++++---- .github/ISSUE_TEMPLATE/feature_request.yml | 38 ++++++------------- .github/ISSUE_TEMPLATE/feature_request_zh.yml | 23 +++++++++++ 4 files changed, 59 insertions(+), 42 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/feature_request_zh.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 091d62f2f..0fdbb6164 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -7,21 +7,25 @@ body: id: ensure attributes: label: Verify steps - description: "Before submitting, please check all the following options to demonstrate that you have read and understood the requirements below, otherwise this issue will be closed." + description: Before submitting, please check all the options below to confirm that you have read and understood the following requirements; otherwise, this issue will be closed. options: - - label: "I have read the [documentation](https://wiki.metacubex.one/) and understand the meaning of all configuration items I have written, avoiding a large number of seemingly useful options or default values." - required: true - - label: "I have not reviewed the [documentation](https://wiki.metacubex.one/) and resolve this issue." + - label: I have read the [documentation](https://wiki.metacubex.one/) and understand the meaning of all the configuration items I have written, rather than just piling up seemingly useful options or default values. required: false - - label: "I have not searched the [Issue Tracker](……/) for the problem I am going to raise." + - label: I have carefully reviewed the [documentation](https://wiki.metacubex.one/) and have not resolved the issue. required: false - - label: "I have tested with the latest Alpha branch version, and the issue still persists." + - label: I have searched the [Issue Tracker](……/) for the issue I want to raise and did not find it. + required: false + - label: I am a non-Chinese user. + required: false + - label: I have tested with the latest Alpha branch version, and the issue still persists. required: true - - label: "I have provided server and client configuration files and processes that can reproduce the issue locally, rather than a desensitized complex client configuration file." + - label: I have provided the server and client configuration files and processes that can reproduce the issue locally, rather than a sanitized complex client configuration file. required: true - - label: "I have provided the simplest configuration that can reproduce the error I reported, rather than relying on remote servers, TUN, graphical client interfaces, or other closed-source software." + - label: I have provided the simplest configuration necessary to reproduce the bug I reported, rather than relying on remote servers, etc. required: true - - label: "I have provided complete configuration files and logs, rather than providing only parts that I believe are useful due to confidence in my own intelligence." + - label: I have provided complete logs, rather than just the parts I think are useful out of confidence in my own intelligence. + required: true + - label: I have directly reproduced the error using the Mihomo command-line program, rather than using other tools or scripts. required: true - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/bug_report_zh.yml b/.github/ISSUE_TEMPLATE/bug_report_zh.yml index 7fd2f2df4..addfa0fd2 100644 --- a/.github/ISSUE_TEMPLATE/bug_report_zh.yml +++ b/.github/ISSUE_TEMPLATE/bug_report_zh.yml @@ -6,22 +6,26 @@ body: - type: checkboxes id: ensure attributes: - label: Verify steps - description: 在提交之前，请勾选以下所有选项以证明您已经阅读并理解了以下要求，否则该 issue 将被关闭。 + label: 验证步骤 + description: 在提交之前，请勾选以下选项以证明您已经阅读并理解了以下要求，否则该 issue 将被关闭。 options: - label: 我已经阅读了 [文档](https://wiki.metacubex.one/)，了解所有我编写的配置文件项的含义，而不是大量堆砌看似有用的选项或默认值。 - required: true - - label: 我未仔细看过 [文档](https://wiki.metacubex.one/) 并解决问题 required: false - - label: 我未在 [Issue Tracker](……/) 中寻找过我要提出的问题 + - label: 我仔细看过 [文档](https://wiki.metacubex.one/) 并未解决问题 + required: false + - label: 我已在 [Issue Tracker](……/) 中寻找过我要提出的问题，并且没有找到 + required: false + - label: 我是中文用户，而非其他语言用户 required: false - label: 我已经使用最新的 Alpha 分支版本测试过，问题依旧存在 required: true - label: 我提供了可以在本地重现该问题的服务器、客户端配置文件与流程，而不是一个脱敏的复杂客户端配置文件。 required: true - - label: 我提供了可用于重现我报告的错误的最简配置，而不是依赖远程服务器、TUN、图形界面客户端或者其他闭源软件。 + - label: 我提供了可用于重现我报告的错误的最简配置，而不是依赖远程服务器等。 required: true - - label: 我提供了完整的配置文件与日志，而不是出于对自身智力的自信而仅提供了部分认为有用的部分。 + - label: 我提供了完整的日志，而不是出于对自身智力的自信而仅提供了部分认为有用的部分。 + required: true + - label: 我直接使用 Mihomo 命令行程序重现了错误，而不是使用其他工具或脚本。 required: true - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 7987526c4..77dc6cddd 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,37 +1,23 @@ -name: Feature request -description: Suggest an idea for this project +name: Feature Request +description: Suggest improvements for this project title: "[Feature] " labels: ["enhancement"] body: - type: checkboxes id: ensure attributes: - label: Verify steps - description: " -在提交之前，请确认 -Please verify that you've followed these steps -" + label: Verification Steps + description: Before submitting, please check the following options to confirm that you have read and understood the requirements below; otherwise, this issue will be closed. options: - - label: " -我已经在 [Issue Tracker](……/) 中找过我要提出的请求 -I have searched on the [issue tracker](……/) for a related feature request. -" - required: true - - label: " -我已经仔细看过 [Documentation](https://wiki.metacubex.one/) 并无法找到这个功能 -I have read the [documentation](https://wiki.metacubex.one/) and was unable to solve the issue. -" - required: true + - label: I have read the [documentation](https://wiki.metacubex.one/) and confirmed that this feature is not implemented + required: false + - label: I have searched for the feature request I want to propose in the [Issue Tracker](……/) and did not find it + required: false + - label: I am a non-Chinese user. + required: false - type: textarea attributes: label: Description - description: 请详细、清晰地表达你要提出的论述，例如这个问题如何影响到你？你想实现什么功能？目前 Mihomo Core 的行为是什麽？ + description: Please provide a detailed description of the feature, rather than vague statements. validations: - required: true - - type: textarea - attributes: - label: Possible Solution - description: " -此项非必须，但是如果你有想法的话欢迎提出。 -Not obligatory, but suggest a fix/reason for the bug, or ideas how to implement the addition or change -" \ No newline at end of file + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request_zh.yml b/.github/ISSUE_TEMPLATE/feature_request_zh.yml new file mode 100644 index 000000000..ab7eccf4f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request_zh.yml @@ -0,0 +1,23 @@ +name: 功能请求 +description: 为该项目提出建议 +title: "[Feature] " +labels: ["enhancement"] +body: + - type: checkboxes + id: ensure + attributes: + label: 验证步骤 + description: 在提交之前，请勾选以下选项以证明您已经阅读并理解了以下要求，否则该 issue 将被关闭。 + options: + - label: 我已经阅读了 [文档](https://wiki.metacubex.one/)，确认了该功能没有实现 + required: false + - label: 我已在 [Issue Tracker](……/) 中寻找过我要提出的功能请求，并且没有找到 + required: false + - label: 我是中文用户，而非其他语言用户 + required: false + - type: textarea + attributes: + label: 描述 + description: 请提供对于该功能的详细描述，而不是莫名其妙的话术。 + validations: + required: true \ No newline at end of file