enoch/Xray-core
1
0
Fork 0
mirror of https://github.com/XTLS/Xray-core.git synced 2025-08-22 17:46:48 +08:00
Code Issues Packages Projects Releases Wiki Activity

Improve the issue templates

Browse Source
This commit is contained in:
风扇滑翔翼
2024-05-14 06:43:40 +00:00
committed by yuhan6665
parent 26d49df22e
commit b98d060ee0
2 changed files with 116 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

77
.github/ISSUE_TEMPLATE/bug_report.yml vendored
View File

@@ -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