mirror of
https://github.com/XTLS/Xray-core.git
synced 2024-11-22 23:13:01 +00:00
Improve the issue templates
This commit is contained in:
风扇滑翔翼
yuhan6665
parent
26d49df22e
commit
b98d060ee0
77
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
77
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
@ -11,34 +11,77 @@ body:
|
||||
required: true
|
||||
- label: I searched issues and did not find any similar issues.
|
||||
required: true
|
||||
- type: textarea
|
||||
- type: input
|
||||
attributes:
|
||||
label: Version
|
||||
description: Xray-core version
|
||||
render: shell
|
||||
description: Version of Xray-core
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Description
|
||||
description: Please provide a detailed description of the bug. And information that you consider valuable.
|
||||
description: Please provide a detailed description of the error. And the information you think valuable.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Reproduction
|
||||
label: Reproduction Method
|
||||
description: |-
|
||||
Provide method to reproduce the bug.
|
||||
Please provide config that can reproduce the problem, including both the server and client.
|
||||
Do not paste a large exported config here. Removing unnecessary inbounds, outbounds, route rules, and options. This cloud help us locate the problem if you really want to get help.
|
||||
Even if you are using a GUI/script/panel, please follow the above requirements.
|
||||
DO NOT just write "I'm using xxx GUI/ xxx panel" instead of providing config. We do not have the energy or obligation to find the software and spend time reproducing according to the description.
|
||||
Based on the configuration you provided below, provide the method to reproduce the bug.
|
||||
validations:
|
||||
required: true
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |-
|
||||
## Configuration and Log Section
|
||||
|
||||
### 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.
|
||||
|
||||
### For logs
|
||||
Please set the log level to debug first.
|
||||
Restart Xray-core, then operate according to the reproduction method, try to reduce the irrelevant part in the log.
|
||||
Remember to delete parts with personal information (such as UUID and IP).
|
||||
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 ```<details><pre><code>``` ```</code></pre></details>``` 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.
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Client config
|
||||
value: |-
|
||||
<details><pre><code>
|
||||
|
||||
</code></pre></details>
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: log
|
||||
description: |-
|
||||
Set the log level to debug.
|
||||
Please Restart Xray-core, and then follow the reproduction method to reduce irrelevant parts in log.
|
||||
Remember to remove personal information such as UUID, IP.
|
||||
Provid complete log, DO NOT just paste the the parts that you think necessary based on your own judgment.
|
||||
render: shell
|
||||
label: Server config
|
||||
value: |-
|
||||
<details><pre><code>
|
||||
|
||||
</code></pre></details>
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Client log
|
||||
value: |-
|
||||
<details><pre><code>
|
||||
|
||||
</code></pre></details>
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Server log
|
||||
value: |-
|
||||
<details><pre><code>
|
||||
|
||||
</code></pre></details>
|
||||
validations:
|
||||
required: true
|
||||
69
.github/ISSUE_TEMPLATE/bug_report_zh.yml
vendored
69
.github/ISSUE_TEMPLATE/bug_report_zh.yml
vendored
@ -11,11 +11,12 @@ body:
|
||||
required: true
|
||||
- label: 我搜索了issues，没有发现已提出的类似问题。
|
||||
required: true
|
||||
- type: textarea
|
||||
- type: input
|
||||
attributes:
|
||||
label: 版本
|
||||
description: 使用的Xray-core版本
|
||||
render: shell
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: 描述
|
||||
@ -26,19 +27,61 @@ body:
|
||||
attributes:
|
||||
label: 重现方式
|
||||
description: |-
|
||||
提供重现BUG方法。
|
||||
请提供可以重现问题的配置文件，包括服务端和客户端
|
||||
基于你下面提供的配置，提供重现BUG方法。
|
||||
validations:
|
||||
required: true
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |-
|
||||
## 配置与日志部分
|
||||
|
||||
### 对于配置文件
|
||||
请提供可以重现问题的配置文件，包括服务端和客户端。
|
||||
不要直接在这里黏贴一大段导出的 config 文件。去掉无用的出入站、规则、选项，这可以帮助确定问题，如果你真的想得到帮助。
|
||||
即使你在使用图形客户端/脚本/面板，也请遵照上述要求。
|
||||
不要直接用“我使用xxx客户端/xxx面板”替代config，我们没有精力也没有义务去找到项目再花时间按描述重新问题。
|
||||
|
||||
### 对于日志
|
||||
请先将日志等级设置为 debug.
|
||||
重启 Xray-core ，再按复现方式操作，尽量减少日志中的无关部分。
|
||||
记得删除有关个人信息（如UUID与IP）的部分。
|
||||
提供 Xray-core 的日志，而不是面板或者别的东西输出的日志。
|
||||
|
||||
### 最后
|
||||
在去掉不影响复现的部分后，提供实际运行的**完整**文件，不要出于自己的判断只提供入站出站或者几行日志。
|
||||
把内容放在文本框预置的 ```<details><pre><code>``` 和 ```</code></pre></details>``` 中间。
|
||||
如果问题十分明确只出现在某一端(如按文档正确编写配置后核心启动失败/崩溃)，可以在下面不需要的项目填入N/A.
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: 客户端配置
|
||||
value: |-
|
||||
<details><pre><code>
|
||||
|
||||
</code></pre></details>
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: 日志
|
||||
description: |-
|
||||
请先将日志等级设置为 debug.
|
||||
重启 Xray-core ，再按复现方式操作，尽量减少日志中的无关部分。
|
||||
记得删除有关个人信息（如UUID与IP）的部分。
|
||||
提供完整的日志，不要仅提供你自己觉得有用的部分。
|
||||
render: shell
|
||||
label: 服务端配置
|
||||
value: |-
|
||||
<details><pre><code>
|
||||
|
||||
</code></pre></details>
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: 客户端日志
|
||||
value: |-
|
||||
<details><pre><code>
|
||||
|
||||
</code></pre></details>
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: 服务端日志
|
||||
value: |-
|
||||
<details><pre><code>
|
||||
|
||||
</code></pre></details>
|
||||
validations:
|
||||
required: true
|
||||
|
||||
Loading…
Reference in New Issue
Block a user