Skip to content

Commit 977eb01

Browse files
committed
Improve the issue templates
1 parent 51504c6 commit 977eb01

File tree

2 files changed

+115
-29
lines changed

2 files changed

+115
-29
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 60 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -11,34 +11,77 @@ body:
1111
required: true
1212
- label: I searched issues and did not find any similar issues.
1313
required: true
14-
- type: textarea
14+
- type: input
1515
attributes:
1616
label: Version
17-
description: Xray-core version
18-
render: shell
17+
description: Version of Xray-core
18+
validations:
19+
required: true
1920
- type: textarea
2021
attributes:
2122
label: Description
22-
description: Please provide a detailed description of the bug. And information that you consider valuable.
23+
description: Please provide a detailed description of the error. And the information you think valuable.
2324
validations:
2425
required: true
2526
- type: textarea
2627
attributes:
27-
label: Reproduction
28+
label: Reproduction Method
2829
description: |-
29-
Provide method to reproduce the bug.
30-
Please provide config that can reproduce the problem, including both the server and client.
31-
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.
32-
Even if you are using a GUI/script/panel, please follow the above requirements.
33-
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.
30+
Based on the configuration you provided below, provide the method to reproduce the bug.
3431
validations:
3532
required: true
33+
- type: markdown
34+
attributes:
35+
value: |-
36+
## Configuration and Log Section
37+
38+
### For config
39+
Please provide the configuration files that can reproduce the problem, including the server and client.
40+
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.
41+
42+
### For logs
43+
Please set the log level to debug first.
44+
Restart Xray-core, then operate according to the reproduction method, try to reduce the irrelevant part in the log.
45+
Remember to delete parts with personal information (such as UUID and IP).
46+
Provide the log of Xray-core, not the log output by the panel or other things.
47+
48+
### Finally
49+
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.
50+
Put the content between the preset ```<details><pre><code>``` ```</code></pre></details>``` in the text box.
51+
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.
3652
- type: textarea
3753
attributes:
38-
label: log
39-
description: |-
40-
Set the log level to debug.
41-
Please Restart Xray-core, and then follow the reproduction method to reduce irrelevant parts in log.
42-
Remember to remove personal information such as UUID, IP.
43-
Provid complete log, DO NOT just paste the the parts that you think necessary based on your own judgment.
44-
render: shell
54+
label: Client config
55+
value: |-
56+
<details><pre><code>
57+
58+
</code></pre></details>
59+
validations:
60+
required: true
61+
- type: textarea
62+
attributes:
63+
label: Server config
64+
value: |-
65+
<details><pre><code>
66+
67+
</code></pre></details>
68+
validations:
69+
required: true
70+
- type: textarea
71+
attributes:
72+
label: Client log
73+
value: |-
74+
<details><pre><code>
75+
76+
</code></pre></details>
77+
validations:
78+
required: true
79+
- type: textarea
80+
attributes:
81+
label: Server log
82+
value: |-
83+
<details><pre><code>
84+
85+
</code></pre></details>
86+
validations:
87+
required: true

.github/ISSUE_TEMPLATE/bug_report_zh.yml

Lines changed: 55 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,12 @@ body:
1111
required: true
1212
- label: 我搜索了issues,没有发现已提出的类似问题。
1313
required: true
14-
- type: textarea
14+
- type: input
1515
attributes:
1616
label: 版本
1717
description: 使用的Xray-core版本
18-
render: shell
18+
validations:
19+
required: true
1920
- type: textarea
2021
attributes:
2122
label: 描述
@@ -26,19 +27,61 @@ body:
2627
attributes:
2728
label: 重现方式
2829
description: |-
29-
提供重现BUG方法。
30-
请提供可以重现问题的配置文件,包括服务端和客户端
31-
不要直接在这里黏贴一大段导出的 config 文件。去掉无用的出入站、规则、选项,这可以帮助确定问题,如果你真的想得到帮助。
32-
即使你在使用图形客户端/脚本/面板,也请遵照上述要求。
33-
不要直接用“我使用xxx客户端/xxx面板”替代config,我们没有精力也没有义务去找到项目再花时间按描述重新问题。
30+
基于你下面提供的配置,提供重现BUG方法。
3431
validations:
3532
required: true
36-
- type: textarea
33+
- type: markdown
3734
attributes:
38-
label: 日志
39-
description: |-
35+
value: |-
36+
## 配置与日志部分
37+
38+
### 对于配置文件
39+
请提供可以重现问题的配置文件,包括服务端和客户端。
40+
不要直接在这里黏贴一大段导出的 config 文件。去掉无用的出入站、规则、选项,这可以帮助确定问题,如果你真的想得到帮助。
41+
42+
### 对于日志
4043
请先将日志等级设置为 debug.
4144
重启 Xray-core ,再按复现方式操作,尽量减少日志中的无关部分。
4245
记得删除有关个人信息(如UUID与IP)的部分。
43-
提供完整的日志,不要仅提供你自己觉得有用的部分。
44-
render: shell
46+
提供 Xray-core 的日志,而不是面板或者别的东西输出的日志。
47+
48+
### 最后
49+
在去掉不影响复现的部分后,提供实际运行的**完整**文件,不要出于自己的判断只提供入站出站或者几行日志。
50+
把内容放在文本框预置的 ```<details><pre><code>``` 和 ```</code></pre></details>``` 中间。
51+
如果问题十分明确只出现在某一端(如按文档正确编写配置后核心启动失败/崩溃),可以在下面不需要的项目填入N/A.
52+
- type: textarea
53+
attributes:
54+
label: 客户端配置
55+
value: |-
56+
<details><pre><code>
57+
58+
</code></pre></details>
59+
validations:
60+
required: true
61+
- type: textarea
62+
attributes:
63+
label: 服务端配置
64+
value: |-
65+
<details><pre><code>
66+
67+
</code></pre></details>
68+
validations:
69+
required: true
70+
- type: textarea
71+
attributes:
72+
label: 客户端日志
73+
value: |-
74+
<details><pre><code>
75+
76+
</code></pre></details>
77+
validations:
78+
required: true
79+
- type: textarea
80+
attributes:
81+
label: 服务端日志
82+
value: |-
83+
<details><pre><code>
84+
85+
</code></pre></details>
86+
validations:
87+
required: true

0 commit comments

Comments
 (0)