github.com/xtls/xray-core@v1.8.12-0.20240518155711-3168d27b0bdb/.github/ISSUE_TEMPLATE/bug_report.yml (about)

     1  name: Bug report
     2  description: "Submit Xray-core bug"
     3  body:
     4    - type: checkboxes
     5      attributes:
     6        label: Integrity requirements
     7        description: |-
     8          Please check all of the following options to prove that you have read and understood the requirements, otherwise this issue will be closed.
     9        options:
    10          - 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.
    11            required: true
    12          - label: I searched issues and did not find any similar issues.
    13            required: true
    14    - type: input
    15      attributes:
    16        label: Version
    17        description: Version of Xray-core
    18      validations:
    19        required: true
    20    - type: textarea
    21      attributes:
    22        label: Description
    23        description: Please provide a detailed description of the error. And the information you think valuable.
    24      validations:
    25        required: true
    26    - type: textarea
    27      attributes:
    28        label: Reproduction Method
    29        description: |-
    30          Based on the configuration you provided below, provide the method to reproduce the bug.
    31      validations:
    32        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.
    52    - type: textarea
    53      attributes:
    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