|
| 1 | +name: Bug Report |
| 2 | +description: Report a bug that you are experiencing. |
| 3 | + |
| 4 | +body: |
| 5 | + - type: markdown |
| 6 | + attributes: |
| 7 | + value: | |
| 8 | + When reporting bugs, please follow the guidelines in this template. This helps identify the problem precisely and thus enables contributors to fix it faster. |
| 9 | + - Write a descriptive issue title above. |
| 10 | + - The golden rule is to **always open *one* issue for *one* bug**. If you notice several bugs and want to report them, make sure to create one new issue for each of them. |
| 11 | + - Ensure that you're on the latest release or commit on main. It's possible that the bug you're reporting has already been fixed in a more recent version of this package. |
| 12 | + - Search open and closed issues to ensure it has not already been reported. If you don't find a relevant match or if you're unsure, don't hesitate to **open a new issue**. |
| 13 | +
|
| 14 | + - type: textarea |
| 15 | + attributes: |
| 16 | + label: Tested Versions |
| 17 | + description: | |
| 18 | + To properly fix a bug, we need to identify if the bug was recently introduced, or if it was always present. |
| 19 | + - Please specify (if applicable) the release version you found the issue in, or the **Git commit hash** if pointing at the main branch. |
| 20 | + placeholder: | |
| 21 | + - Reproducible in: 1.1, 0511aa5. |
| 22 | + - Not reproducible in: b0ff83c2. |
| 23 | + validations: |
| 24 | + required: true |
| 25 | + |
| 26 | + - type: textarea |
| 27 | + attributes: |
| 28 | + label: Issue Description |
| 29 | + description: | |
| 30 | + Describe your issue briefly. What doesn't work, and how do you expect it to work instead? |
| 31 | + You can format code blocks or logs with <code>\`\`\`</code> tags, on separate lines before and after the text. (Use <code>\`\`\`go</code> to add Go syntax highlighting.) |
| 32 | + If adding logs, please add them to a details section, so they can be toggled, e.g. `<details><summary>Logs</summary>log lines...</details>`. |
| 33 | + Please do not add code examples or error messages as screenshots, but as text, this helps searching for issues and testing the code. |
| 34 | + validations: |
| 35 | + required: true |
| 36 | + |
| 37 | + - type: textarea |
| 38 | + attributes: |
| 39 | + label: Steps to Reproduce |
| 40 | + description: | |
| 41 | + List of steps or sample code that reproduces the issue. Having reproducible issues is a prerequisite for contributors to be able to solve them. |
| 42 | + If you include a minimal reproduction project below, you can detail how to use it here. |
| 43 | + validations: |
| 44 | + required: true |
| 45 | + |
| 46 | + - type: textarea |
| 47 | + attributes: |
| 48 | + label: Minimal Reproduction Project (MRP) |
| 49 | + description: | |
| 50 | + - A small project which reproduces the issue, with no unnecessary files included. |
| 51 | + - Having an MRP is appreciated by contributors to be able to reproduce the bug in the same way that you are experiencing it. When testing a potential fix for the issue, contributors will use the MRP to validate that the fix is working as intended. |
| 52 | + - Drag and drop a ZIP archive to upload it (max 10 MB). **Do not select another field until the project is done uploading.** |
| 53 | + validations: |
| 54 | + required: false |
0 commit comments