diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml deleted file mode 100644 index 7f7d046..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ /dev/null @@ -1,81 +0,0 @@ -name: Bug report -description: Create a report to help us improve -title: "[Bug] " -body: - - type: checkboxes - id: ensure - attributes: - label: Verify steps - description: " -在提交之前，请确认 -Please verify that you've followed these steps -" - options: - - label: " -确保你使用的是**本仓库**最新的的 clash 或 clash premium 版本 -Ensure you are using the latest version of Clash or Clash Premium from **this repository**. -" - required: true - - label: " -如果你可以自己 debug 并解决的话，提交 PR 吧 -Is this something you can **debug and fix**? Send a pull request! Bug fixes and documentation fixes are welcome. -" - required: true - - label: " -我已经在 [Issue Tracker](……/) 中找过我要提出的问题 -I have searched on the [issue tracker](……/) for a related issue. -" - required: true - - label: " -我已经使用 dev 分支版本测试过，问题依旧存在 -I have tested using the dev branch, and the issue still exists. -" - required: true - - label: " -我已经仔细看过 [Documentation](https://github.com/Dreamacro/clash/wiki/) 并无法自行解决问题 -I have read the [documentation](https://github.com/Dreamacro/clash/wiki/) and was unable to solve the issue. -" - required: true - - label: " -这是 Clash 核心的问题，并非我所使用的 Clash 衍生版本（如 OpenClash、KoolClash 等）的特定问题 -This is an issue of the Clash core *per se*, not to the derivatives of Clash, like OpenClash or KoolClash. -" - required: true - - type: input - attributes: - label: Clash version - validations: - required: true - - type: dropdown - id: os - attributes: - label: What OS are you seeing the problem on? - multiple: true - options: - - macOS - - Windows - - Linux - - OpenBSD/FreeBSD - - type: textarea - attributes: - render: yaml - label: "Clash config" - description: " -在下方附上 Clash core 配置文件，请确保配置文件中没有敏感信息（比如：服务器地址，密码，端口等） -Paste the Clash core configuration file below, please make sure that there is no sensitive information in the configuration file (e.g., server address/url, password, port) -" - validations: - required: true - - type: textarea - attributes: - render: shell - label: Clash log - description: " -在下方附上 Clash Core 的日志，log level 使用 DEBUG -Paste the Clash core log below with the log level set to `DEBUG`. -" - - type: textarea - attributes: - label: Description - validations: - required: true diff --git a/.github/ISSUE_TEMPLATE/bug_report_en.yml b/.github/ISSUE_TEMPLATE/bug_report_en.yml new file mode 100644 index 0000000..2ddf715 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report_en.yml @@ -0,0 +1,124 @@ +name: (English) Report a bug of the Clash core +description: Create a bug report to help us improve +labels: + - bug +title: "[Bug] " +body: + - type: markdown + attributes: + value: "## Welcome to the official Clash open-source community" + + - type: markdown + attributes: + value: | + Thank you for taking the time to report an issue with the Clash core. + + Prior to submitting this issue, please read and follow the guidelines below to ensure that your issue can be resolved as quickly as possible. Options marked with an asterisk (*) are required, while others are optional. If the information you provide does not comply with the requirements, the maintainers may not respond and may directly close the issue. + + If you can debug and fix the issue yourself, we welcome you to submit a pull request to merge your changes upstream. + + - type: checkboxes + id: ensure + attributes: + label: Prerequisites + description: "If any of the following options do not apply, please do not submit this issue as we will close it" + options: + - label: "I understand that this is the official open-source version of the Clash core, **only providing support for the open-source version or Premium version**" + required: true + - label: "I am submitting an issue with the Clash core, not Clash.Meta / OpenClash / ClashX / Clash For Windows or any other derivative version" + required: true + - label: "I am using the latest version of the Clash or Clash Premium core **in this repository**" + required: true + - label: "I have searched at the [Issue Tracker](……/) **and have not found any related issues**" + required: true + - label: "I have read the [official Wiki](https://github.com/Dreamacro/clash/wiki/) **and was unable to solve the issue**" + required: true + - label: "(required for Premium core) I've tried the `dev` branch and the issue still exists" + required: false + + - type: markdown + attributes: + value: "## Environment" + - type: markdown + attributes: + value: | + Please provide the following information to help us locate the issue. + The issue might be closed if there's not enough information provided. + + - type: input + attributes: + label: Version + description: "Run `clash -v` or look at the bottom-left corner of the Clash Dashboard to find out" + validations: + required: true + + - type: dropdown + id: os + attributes: + label: Operating System + description: "Select all operating systems that apply to this issue" + multiple: true + options: + - Linux + - Windows + - macOS (darwin) + - Android + - OpenBSD / FreeBSD + + - type: dropdown + id: arch + attributes: + label: Architecture + description: "Select all architectures that apply to this issue" + multiple: true + options: + - amd64 + - amd64-v3 + - arm64 + - "386" + - armv5 + - armv6 + - armv7 + - mips-softfloat + - mips-hardfloat + - mipsle-softfloat + - mipsle-hardfloat + - mips64 + - mips64le + - riscv64 + + - type: markdown + attributes: + value: "## Clash related information" + - type: markdown + attributes: + value: | + Please provide relevant information about your Clash instance here. If you + do not provide enough information, the issue may be closed. + + - type: textarea + attributes: + render: YAML + label: Configuration File + placeholder: "Ensure that there is no sensitive information (such as server addresses, passwords, or ports) in the configuration file, and provide the minimum reproducible configuration. Do not post configurations with thousands of lines." + validations: + required: true + + - type: textarea + attributes: + render: Text + label: Log + placeholder: "Please attach the corresponding core outout (setting `log-level: DEBUG` in the configuration provides debugging information)." + + - type: textarea + attributes: + label: Description + placeholder: "Please describe your issue in detail here to help us understand (supports Markdown syntax)." + validations: + required: true + + - type: textarea + attributes: + label: Reproduction Steps + placeholder: "Please provide the specific steps to reproduce the issue here (supports Markdown syntax)." + diff --git a/.github/ISSUE_TEMPLATE/bug_report_zh.yml b/.github/ISSUE_TEMPLATE/bug_report_zh.yml new file mode 100644 index 0000000..f0e998e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report_zh.yml @@ -0,0 +1,121 @@ +name: （中文）提交 Clash 核心的问题 +description: 如果 Clash 核心运作不符合预期，在这里提交问题 +labels: + - bug +title: "[Bug] <问题标题>" +body: + - type: markdown + attributes: + value: "## 欢迎来到 Clash 官方开源社区！" + + - type: markdown + attributes: + value: | + 感谢你拨冗提交 Clash 内核的问题。在提交之前，请仔细阅读并遵守以下指引，以确保你的问题能够被尽快解决。 + 带有星号（*）的选项为必填，其他可选填。**如果你填写的资料不符合规范，维护者可能不予回复，并直接关闭这个 issue。** + 如果你可以自行 debug 并且修正，我们随时欢迎你提交 Pull Request，将你的修改合并到上游。 + + - type: checkboxes + id: ensure + attributes: + label: 先决条件 + description: "若以下任意选项不适用，请勿提交这个 issue，因为我们会把它关闭" + options: + - label: "我了解这里是官方开源版 Clash 核心仓库，**只提供开源版或者 Premium 内核的支持**" + required: true + - label: "我要提交 Clash 核心的问题，并非 Clash.Meta / OpenClash / ClashX / Clash For Windows 或其他任何衍生版本的问题" + required: true + - label: "我使用的是**本仓库**最新版本的 Clash 或 Clash Premium 内核" + required: true + - label: "我已经在 [Issue Tracker](……/) 中找过我要提出的 bug，**并且没有找到相关问题**" + required: true + - label: "我已经仔细阅读 [官方 Wiki](https://github.com/Dreamacro/clash/wiki/) 并无法自行解决问题" + required: true + - label: "（非 Premium 内核必填）我已经使用 dev 分支版本测试过，问题依旧存在" + required: false + + - type: markdown + attributes: + value: "## 系统环境" + - type: markdown + attributes: + value: | + 请附上这个问题适用的环境，以帮助我们迅速定位问题并解决。若你提供的信息不足，我们将关闭 + 这个 issue 并要求你提供更多信息。 + + - type: input + attributes: + label: 版本 + description: "运行 `clash -v` 或者查看 Clash Dashboard 的左下角来找到你现在使用的版本" + validations: + required: true + + - type: dropdown + id: os + attributes: + label: 适用的作业系统 + description: "勾选所有适用于这个 issue 的系统" + multiple: true + options: + - Linux + - Windows + - macOS (darwin) + - Android + - OpenBSD / FreeBSD + + - type: dropdown + id: arch + attributes: + label: 适用的硬件架构 + description: "勾选所有适用于这个 issue 的架构" + multiple: true + options: + - amd64 + - amd64-v3 + - arm64 + - "386" + - armv5 + - armv6 + - armv7 + - mips-softfloat + - mips-hardfloat + - mipsle-softfloat + - mipsle-hardfloat + - mips64 + - mips64le + - riscv64 + + - type: markdown + attributes: + value: "## Clash 相关信息" + - type: markdown + attributes: + value: | + 请附上与这个问题直接相关的相应信息，以帮助我们迅速定位问题并解决。 + 若你提供的信息不足，我们将关闭这个 issue 并要求你提供更多信息。 + + - type: textarea + attributes: + render: YAML + label: "配置文件" + placeholder: "确保配置文件中没有敏感信息（如：服务器地址、密码、端口），并且提供最小可复现配置，严禁贴上上千行的配置" + validations: + required: true + + - type: textarea + attributes: + render: Text + label: 日志输出 + placeholder: "在这里附上问题对应的内核日志（在配置中设置 `log-level: DEBUG` 可获得调试信息）" + + - type: textarea + attributes: + label: 问题描述 + placeholder: "在这里详细叙述你的问题，帮助我们理解（支持 Markdown 语法）" + validations: + required: true + + - type: textarea + attributes: + label: 复现步骤 + placeholder: "在这里提供问题的具体重现步骤（支持 Markdown 语法）" diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 7404fe2..109c611 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,6 +1,9 @@ blank_issues_enabled: false contact_links: - - name: Get help in GitHub Discussions - url: https://github.com/Dreamacro/clash/discussions - about: Have a question? Not sure if your issue affects everyone reproducibly? The quickest way to get help is on Clash's GitHub Discussions! + - name: （中文）阅读 Wiki + url: https://github.com/Dreamacro/clash/wiki/ + about: 如果你是新手，或者想要了解 Clash 的更多信息，请阅读我们撰写的官方 Wiki + - name: (English) Read our Wiki page + url: https://github.com/Dreamacro/clash/wiki/ + about: If you are new to Clash, or want to know more about Clash, please read our Wiki page diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml deleted file mode 100644 index 34668d1..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ /dev/null @@ -1,36 +0,0 @@ -name: Feature request -description: Suggest an idea for this project -title: "[Feature] " -body: - - type: checkboxes - id: ensure - attributes: - label: Verify steps - description: " -在提交之前，请确认 -Please verify that you've followed these steps -" - options: - - label: " -我已经在 [Issue Tracker](……/) 中找过我要提出的请求 -I have searched on the [issue tracker](……/) for a related feature request. -" - required: true - - label: " -我已经仔细看过 [Documentation](https://github.com/Dreamacro/clash/wiki/) 并无法自行解决问题 -I have read the [documentation](https://github.com/Dreamacro/clash/wiki/) and was unable to solve the issue. -" - required: true - - type: textarea - attributes: - label: Description - description: 请详细、清晰地表达你要提出的论述，例如这个问题如何影响到你？你想实现什么功能？目前 Clash Core 的行为是什麽？ - 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 -" diff --git a/.github/ISSUE_TEMPLATE/feature_request_en.yml b/.github/ISSUE_TEMPLATE/feature_request_en.yml new file mode 100644 index 0000000..84302c3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request_en.yml @@ -0,0 +1,43 @@ +name: (English) Feature request +description: Suggest an idea for this project +labels: + - enhancement +title: "[Feature] " +body: + - type: markdown + attributes: + value: "## Welcome to the official Clash open-source community" + + - type: markdown + attributes: + value: | + Thank you for taking the time to make a suggestion to the Clash core. + + Prior to submitting this issue, please read and follow the guidelines below to ensure that your issue can be resolved as quickly as possible. Options marked with an asterisk (*) are required, while others are optional. If the information you provide does not comply with the requirements, the maintainers may not respond and may directly close the issue. + + If you can implement your idea by yourself, we welcome you to submit a pull request to merge your changes upstream. + + - type: checkboxes + id: ensure + attributes: + label: Prerequisites + description: "If any of the following options do not apply, please do not submit this issue as we will close it" + options: + - label: "I understand that this is the official open-source version of the Clash core, **only providing support for the open-source version or Premium version**" + required: true + - label: "I have looked for my idea in [the issue tracker](https://github.com/Dreamacro/clash/issues?q=is%3Aissue+label%3Aenhancement), **and found none of which being related**" + required: true + - label: "I have read the [official Wiki](https://github.com/Dreamacro/clash/wiki/)" + required: true + + - type: textarea + attributes: + label: Description + placeholder: "Please explain your suggestions in detail and in a clear manner. For instance, how does this issue impact you? What specific functionality are you hoping to achieve? Also, let us know what Clash Core is currently doing in terms of your suggestion, and what you would like it to do instead." + validations: + required: true + + - type: textarea + attributes: + label: Possible Solution + placeholder: "Do you have any ideas on the implementation details?" diff --git a/.github/ISSUE_TEMPLATE/feature_request_zh.yml b/.github/ISSUE_TEMPLATE/feature_request_zh.yml new file mode 100644 index 0000000..4450d87 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request_zh.yml @@ -0,0 +1,41 @@ +name: （中文）建议一个新功能 +description: 在这里提供一个的想法或建议 +labels: + - enhancement +title: "[Feature] <标题>" +body: + - type: markdown + attributes: + value: "## 欢迎来到 Clash 官方开源社区！" + + - type: markdown + attributes: + value: | + 感谢你拨冗为 Clash 内核提供建议。在提交之前，请仔细阅读并遵守以下指引，以确保你的建议能够被顺利采纳。 + 带有星号（*）的选项为必填，其他可选填。**如果你填写的资料不符合规范，维护者可能不予回复，并直接关闭这个 issue。** + 如果你可以自行添加这个功能，我们随时欢迎你提交 Pull Request，并将你的修改合并到上游。 + + - type: checkboxes + id: ensure + attributes: + label: 先决条件 + description: "若以下任意选项不适用，请勿提交这个 issue，因为我们会把它关闭" + options: + - label: "我了解这里是 Clash 官方仓库，并非 Clash.Meta / OpenClash / ClashX / Clash For Windows 或其他任何衍生版本" + required: true + - label: "我已经在[这里](https://github.com/Dreamacro/clash/issues?q=is%3Aissue+label%3Aenhancement)找过我要提出的建议，**并且没有找到相关问题**" + required: true + - label: "我已经仔细阅读 [官方 Wiki](https://github.com/Dreamacro/clash/wiki/) " + required: true + + - type: textarea + attributes: + label: 描述 + placeholder: 请详细、清晰地表达你要提出的论述，例如这个问题如何影响到你？你想实现什么功能？目前 Clash Core 的行为是什么？ + validations: + required: true + + - type: textarea + attributes: + label: 可能的解决方案 + placeholder: 此项非必须，但是如果你有想法的话欢迎提出。