Skip to content

Commit

Permalink
新增issue模板 (XTLS#3290)
Browse files Browse the repository at this point in the history
* Add issue template

* Do some refine

* Add checkbox
  • Loading branch information
Fangliding authored Apr 19, 2024
1 parent c85a91b commit 55e42c8
Show file tree
Hide file tree
Showing 2 changed files with 84 additions and 0 deletions.
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Bug report
description: "Submit Xray-core bug"
body:
- type: checkboxes
attributes:
label: Integrity requirements
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 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 searched issues and did not find any similar issues.
required: true
- type: textarea
attributes:
label: Version
description: Xray-core version
render: shell
- type: textarea
attributes:
label: Description
description: Please provide a detailed description of the bug. And information that you consider valuable.
validations:
required: true
- type: textarea
attributes:
label: Reproduction
description: |-
Provide method to reproduce the bug.
Please provide config that can reproduce the problem, including both the server and client, removing unnecessary inbounds, outbounds, route rules, and options. This cloud help us locate the problem if you really want to get help.
Do not paste a large exported config here.
Even if you are using a GUI/script/panel, please follow the above requirements. We do not have the energy or obligation to find the software and spend time reproducing according to the description.
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.
render: shell
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report_zh.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: bug反馈
description: "提交 Xray-core bug"
body:
- type: checkboxes
attributes:
label: 完整性要求
description: |-
请勾选以下所有选项以证明您已经阅读并理解了以下要求,否则该 issue 将被关闭。
options:
- label: 我保证阅读了文档,了解所有我编写的配置文件项的含义,而不是大量堆砌看似有用的选项或默认值。
required: true
- label: 我搜索了issues,没有发现已提出的类似问题。
required: true
- type: textarea
attributes:
label: 版本
description: 使用的Xray-core版本
render: shell
- type: textarea
attributes:
label: 描述
description: 请提供错误的详细描述。以及你认为有价值的信息。
validations:
required: true
- type: textarea
attributes:
label: 重现方式
description: |-
提供重现BUG方法。
请提供可以重现问题的配置文件,包括服务端和客户端,去掉无用的出入站、规则、选项,这可以帮助确定问题,如果你真的想得到帮助。
不要直接在这里黏贴一大段导出的 config 文件。
即使你在使用图形客户端/脚本/面板,也请遵照上述要求,我们没有精力也没有义务去找到项目再花时间按描述重新问题。
validations:
required: true
- type: textarea
attributes:
label: 日志
description: |-
请先将日志等级设置为 debug.
重启 Xray-core ,再按复现方式操作,尽量减少日志中的无关部分。
记得删除有关个人信息(如UUID与IP)的部分。
render: shell

0 comments on commit 55e42c8

Please sign in to comment.