From 573300bc22f23da91a9cd49a2699e11380af40a9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=A3=8E=E6=89=87=E6=BB=91=E7=BF=94=E7=BF=BC?= Date: Tue, 19 Aug 2025 09:27:25 +0000 Subject: [PATCH] Issues template: Refine requirements --- .github/ISSUE_TEMPLATE/bug_report.yml | 29 ++++++++---------------- .github/ISSUE_TEMPLATE/bug_report_zh.yml | 29 ++++++++---------------- 2 files changed, 20 insertions(+), 38 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 32f58b19..3a5c04f8 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -7,6 +7,8 @@ body: description: |- Please check all of the following options to prove that you have read and understood the requirements, otherwise this issue will be closed. options: + - label: I have read all the comments in the issue template and ensured that this issue meet the requirements. + required: true - label: I confirm that I have read the documentation, understand the meaning of all the configuration items I wrote, and did not pile up seemingly useful options or default values. required: true - label: I provided the complete config and logs, rather than just providing the truncated parts based on my own judgment. @@ -38,6 +40,8 @@ body: ### For config Please provide the configuration files that can reproduce the problem, including the server and client. Don't just paste a big exported config file here. Eliminate useless inbound/outbound, rules, options, this can help determine the problem, if you really want to get help. + After removing parts that do not affect reproduction, provide the actual running **complete** file. + meaning of complete: This config can be directly used to start the core, **not a truncated part of the config**. For fields like keys, use newly generated valid parameters that have not been actually used to fill in. ### For logs Please set the log level to debug and dnsLog to true first. @@ -46,42 +50,29 @@ body: Provide the log of Xray-core, not the log output by the panel or other things. ### Finally - After removing parts that do not affect reproduction, provide the actual running **complete** file, do not only provide inbound or outbound or a few lines of logs based on your own judgment. - Put the content between the preset ```
``` ```
``` in the text box. - If the problem is very clear that only related to one end (such as core startup failure/crash after correctly writing the config according to the documents), N/A can be filled in for unnecessary areas below. + The specific content to be filled in each of the following text boxes needs to be placed between ```
``` and ```
```, like this + ``` + 

+        (config)
+
+ ``` - type: textarea attributes: label: Client config - value: |- - 

-
-
validations: required: true - type: textarea attributes: label: Server config - value: |- - 

-
-
validations: required: true - type: textarea attributes: label: Client log - value: |- - 

-
-
validations: required: true - type: textarea attributes: label: Server log - value: |- - 

-
-
validations: required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report_zh.yml b/.github/ISSUE_TEMPLATE/bug_report_zh.yml index 201f847e..939f663c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report_zh.yml +++ b/.github/ISSUE_TEMPLATE/bug_report_zh.yml @@ -7,6 +7,8 @@ body: description: |- 请勾选以下所有选项以证明您已经阅读并理解了以下要求，否则该 issue 将被关闭。 options: + - label: 我读完了 issue 模板中的所有注释，确保填写符合要求。 + required: true - label: 我保证阅读了文档，了解所有我编写的配置文件项的含义，而不是大量堆砌看似有用的选项或默认值。 required: true - label: 我提供了完整的配置文件和日志，而不是出于自己的判断只给出截取的部分。 @@ -38,6 +40,8 @@ body: ### 对于配置文件 请提供可以重现问题的配置文件，包括服务端和客户端。 不要直接在这里黏贴一大段导出的 config 文件。去掉无用的出入站、规则、选项，这可以帮助确定问题，如果你真的想得到帮助。 + 在去掉不影响复现的部分后，提供实际运行的**完整**文件。 + 完整的含义：可以直接使用这个配置启动核心，**不是截取的部分配置**。对于密钥等参数使用重新生成未实际使用的有效参数填充。 ### 对于日志 请先将日志等级设置为 debug, dnsLog 设置为true. @@ -46,42 +50,29 @@ body: 提供 Xray-core 的日志，而不是面板或者别的东西输出的日志。 ### 最后 - 在去掉不影响复现的部分后，提供实际运行的**完整**文件，不要出于自己的判断只提供入站出站或者几行日志。 - 把内容放在文本框预置的 ```
``` 和 ```
``` 中间。 - 如果问题十分明确只出现在某一端(如按文档正确编写配置后核心启动失败/崩溃)，可以在下面不需要的项目填入N/A. + 把下面的每格具体内容需要放在 ```
``` 和 ```
``` 中间，如 + ``` + 

+        (config)
+
+ ``` - type: textarea attributes: label: 客户端配置 - value: |- - 

-
-
validations: required: true - type: textarea attributes: label: 服务端配置 - value: |- - 

-
-
validations: required: true - type: textarea attributes: label: 客户端日志 - value: |- - 

-
-
validations: required: true - type: textarea attributes: label: 服务端日志 - value: |- - 

-
-
validations: required: true