|
| 1 | +# yaml-language-server: $schema=https://json.schemastore.org/github-issue-forms.json |
| 2 | +name: "Bug Report" |
| 3 | +description: "Report a bug." |
| 4 | +labels: |
| 5 | + - "Type/Bug 🐛" |
| 6 | +body: |
| 7 | + - type: "input" |
| 8 | + id: "version" |
| 9 | + attributes: |
| 10 | + label: "Version" |
| 11 | + description: |- |
| 12 | + Which version occur this bug? Version must be supported at the time of submit, the supported versions are listed in the Security Policy file `SECURITY.md`. |
| 13 | +
|
| 14 | + > [!NOTE] |
| 15 | + > - For multiple versions, separate each version with comma-space (`, `), or use versions range syntax from [OSGi](https://docs.osgi.org/whitepaper/semantic-versioning/040-semantic-versions.html) or [SemVer](https://devhints.io/semver). |
| 16 | + placeholder: "1.0.2" |
| 17 | + validations: |
| 18 | + required: true |
| 19 | + - type: "textarea" |
| 20 | + id: "describe" |
| 21 | + attributes: |
| 22 | + label: "Describe" |
| 23 | + description: |- |
| 24 | + What the bug is? If needed, use images, videos, or other media type to help for explain this bug. |
| 25 | +
|
| 26 | + > [!NOTE] |
| 27 | + > - For external media, please ensure we are able to view those without any extra step. |
| 28 | + placeholder: |- |
| 29 | + It unable to XXXXXXXX. |
| 30 | + validations: |
| 31 | + required: true |
| 32 | + - type: "input" |
| 33 | + id: "behaviour-expected" |
| 34 | + attributes: |
| 35 | + label: "Behaviour Expected" |
| 36 | + description: |- |
| 37 | + What things should expected to happen? |
| 38 | + placeholder: |- |
| 39 | + It should XXXXXXXX. |
| 40 | + validations: |
| 41 | + required: false |
| 42 | + - type: "input" |
| 43 | + id: "behaviour-actual" |
| 44 | + attributes: |
| 45 | + label: "Behaviour Actual" |
| 46 | + description: |- |
| 47 | + What things happened instead of the expected? |
| 48 | + placeholder: |- |
| 49 | + It XXXXXXXX. |
| 50 | + validations: |
| 51 | + required: false |
| 52 | + - type: "textarea" |
| 53 | + id: "reproduce" |
| 54 | + attributes: |
| 55 | + label: "To Reproduce" |
| 56 | + description: |- |
| 57 | + Is this bug reproducible? If reproducible, please show the reproduce steps; If needed, use images, videos, or other media to help for show the reproduce steps. |
| 58 | +
|
| 59 | + > [!NOTE] |
| 60 | + > - For external media, please ensure we are able to view those without any extra step. |
| 61 | + placeholder: |- |
| 62 | + 1. Go to XXXXXXXX. |
| 63 | + 2. Click on XXXXXXXX. |
| 64 | + 3. Scroll to XXXXXXXX. |
| 65 | + 4. Encounter this bug. |
| 66 | + validations: |
| 67 | + required: false |
| 68 | + - type: "dropdown" |
| 69 | + id: "frequency" |
| 70 | + attributes: |
| 71 | + label: "Frequency" |
| 72 | + description: |- |
| 73 | + How often does this bug occur? |
| 74 | + options: |
| 75 | + - "Unknown / Untested" |
| 76 | + - "Always (~100%)" |
| 77 | + - "Frequently (~75%)" |
| 78 | + - "Half (~50%)" |
| 79 | + - "Sometimes (~25%)" |
| 80 | + - "Rarely (~5%)" |
| 81 | + multiple: false |
| 82 | + default: 0 |
| 83 | + validations: |
| 84 | + required: true |
| 85 | + - type: "textarea" |
| 86 | + id: "execution-environment" |
| 87 | + attributes: |
| 88 | + label: "Execution Environment" |
| 89 | + description: |- |
| 90 | + How is the execution environment? Different execution environment may have different outcome, provide this information may help for reproduce this bug. |
| 91 | +
|
| 92 | + These are common categories: |
| 93 | +
|
| 94 | + - **`type`:** Device type (e.g.: `computer`, `phone`, `server`). |
| 95 | + - **`cpu`:** Details of the central processing unit (e.g.: `Intel i7-6700`). |
| 96 | + - **`ram`:** Details of the random access memory (e.g.: `8 GB`). |
| 97 | + - **`storage`:** Details of the storage unit (e.g.: `500 GB SSD`). |
| 98 | + - **`network`:** Details of the network. |
| 99 | + - **`gpu`:** Details of the graphics processing unit (e.g.: `NVIDIA GeForce RTX 4090`). |
| 100 | + - **`os`:** Details of the operate system (e.g.: `Windows 11 Professional 23H2 X64`). |
| 101 | + - **`softwares`:** List of the installed softwares (e.g.: `NodeJS 20.6.0 X64`, `Deno 1.36.0 X64`). |
| 102 | + - **`env`:** List of the environment variables (e.g.: `NO_COLOR=1`). |
| 103 | +
|
| 104 | + > [!NOTE] |
| 105 | + > - Accept multiple execution environments. |
| 106 | + > - All of the categories are optional. |
| 107 | +
|
| 108 | + **\[🖌️ YAML\]** |
| 109 | + render: "yml" |
| 110 | + validations: |
| 111 | + required: false |
| 112 | + - type: "textarea" |
| 113 | + id: "additional-information" |
| 114 | + attributes: |
| 115 | + label: "Additional Information" |
| 116 | + description: |- |
| 117 | + If there have information which relevant to this bug but not suitable at other fields, please list those at here. |
| 118 | + validations: |
| 119 | + required: false |
0 commit comments