mermaid/.github/ISSUE_TEMPLATE/bug_report.yml

74 lines
2.6 KiB
YAML
Raw Normal View History

2022-02-16 21:51:02 +01:00
name: Bug Report
description: Create a report to help us improve
labels:
2022-10-29 20:37:12 +02:00
- 'Status: Triage'
- 'Type: Bug / Error'
2022-02-16 21:51:02 +01:00
body:
2022-02-16 22:14:21 +01:00
- type: markdown
attributes:
value: |-
2022-11-03 06:23:15 +01:00
## Security vulnerabilities
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.
2022-02-16 22:14:21 +01:00
## Before you submit...
We like to help you, but in order to do that should you make a few things first:
2022-10-29 20:37:12 +02:00
2022-02-16 22:14:21 +01:00
- Use a clear and concise title
- Fill out the text fields with as much detail as possible.
- Never be shy to give us screenshots and/or code samples. It will help!
2023-09-15 10:23:07 +02:00
There is a chance that the bug is already fixed in the git `develop` branch, but is not released yet.
2023-09-22 06:50:16 +02:00
So please check in [Live Editor - Develop](https://develop.git.mermaid.live) before raising an issue.
2022-02-16 21:51:02 +01:00
- type: textarea
attributes:
label: Description
description: Give a clear and concise description of what the bug is.
placeholder: When I do ... does ... happen.
validations:
required: true
- type: textarea
attributes:
label: Steps to reproduce
description: Give a step-by-step example on how to reproduce the bug.
placeholder: |-
1. Do this
2. Do that
3. ...
4. Bug!
validations:
required: true
- type: textarea
attributes:
label: Screenshots
description: If applicable, add screenshots to help explain your issue.
- type: textarea
attributes:
label: Code Sample
description: |-
2023-09-22 06:50:16 +02:00
If applicable, add the code sample or a link to the [Live Editor - Develop](https://develop.git.mermaid.live).
2022-02-16 21:51:02 +01:00
Any text pasted here will be rendered as a Code block.
render: text
- type: textarea
attributes:
label: Setup
description: |-
Please fill out the info below.
2023-03-03 07:25:18 +01:00
Note that you only need to fill out the relevant section
2022-02-16 21:51:02 +01:00
value: |-
- Mermaid version:
2022-02-16 21:51:02 +01:00
- Browser and Version: [Chrome, Edge, Firefox]
- type: textarea
attributes:
label: Suggested Solutions
description: >
If applicable, suggest solutions that could resolve the bug.
It would help maintainers/contributors to not waste time looking for the solution. Even pointing the line causing the bug would be great!
placeholder: |-
- Variable `parser` in file <filepath> is not initialised ...
- Add a new type for ...
2022-02-16 21:51:02 +01:00
- type: textarea
attributes:
label: Additional Context
description: Anything else to add?