| 1 | name: Bug Report |
| 2 | description: Create a report to help us improve |
| 3 | labels: |
| 4 | - 'Status: Triage' |
| 5 | - 'Type: Bug / Error' |
| 6 | |
| 7 | body: |
| 8 | - type: markdown |
| 9 | attributes: |
| 10 | value: |- |
| 11 | ## Security vulnerabilities |
| 12 | Please refer our [Security Policy](https://github.com/mermaid-js/.github/blob/main/SECURITY.md) and report to keep vulnerabilities confidential so we can release fixes first. |
| 13 | |
| 14 | ## Before you submit... |
| 15 | We like to help you, but in order to do that should you make a few things first: |
| 16 | |
| 17 | - Use a clear and concise title |
| 18 | - Fill out the text fields with as much detail as possible. |
| 19 | - Never be shy to give us screenshots and/or code samples. It will help! |
| 20 | |
| 21 | There is a chance that the bug is already fixed in the git `develop` branch, but is not released yet. |
| 22 | So please check in [Live Editor - Develop](https://develop.git.mermaid.live) before raising an issue. |
| 23 | - type: textarea |
| 24 | attributes: |
| 25 | label: Description |
| 26 | description: Give a clear and concise description of what the bug is. |
| 27 | placeholder: When I do ... does ... happen. |
| 28 | validations: |
| 29 | required: true |
| 30 | - type: textarea |
| 31 | attributes: |
| 32 | label: Steps to reproduce |
| 33 | description: Give a step-by-step example on how to reproduce the bug. |
| 34 | placeholder: |- |
| 35 | 1. Do this |
| 36 | 2. Do that |
| 37 | 3. ... |
| 38 | 4. Bug! |
| 39 | validations: |
| 40 | required: true |
| 41 | - type: textarea |
| 42 | attributes: |
| 43 | label: Screenshots |
| 44 | description: If applicable, add screenshots to help explain your issue. |
| 45 | - type: textarea |
| 46 | attributes: |
| 47 | label: Code Sample |
| 48 | description: |- |
| 49 | If applicable, add the code sample or a link to the [Live Editor - Develop](https://develop.git.mermaid.live). |
| 50 | Any text pasted here will be rendered as a Code block. |
| 51 | render: text |
| 52 | - type: textarea |
| 53 | attributes: |
| 54 | label: Setup |
| 55 | description: |- |
| 56 | Please fill out the info below. |
| 57 | Note that you only need to fill out the relevant section |
| 58 | value: |- |
| 59 | - Mermaid version: |
| 60 | - Browser and Version: [Chrome, Edge, Firefox] |
| 61 | - type: textarea |
| 62 | attributes: |
| 63 | label: Suggested Solutions |
| 64 | description: > |
| 65 | If applicable, suggest solutions that could resolve the bug. |
| 66 | It would help maintainers/contributors to not waste time looking for the solution. Even pointing the line causing the bug would be great! |
| 67 | placeholder: |- |
| 68 | - Variable `parser` in file <filepath> is not initialised ... |
| 69 | - Add a new type for ... |
| 70 | - type: textarea |
| 71 | attributes: |
| 72 | label: Additional Context |
| 73 | description: Anything else to add? |
| 74 | |