61 lines
2.2 KiB
YAML
61 lines
2.2 KiB
YAML
name: Diagram Proposal
|
|
description: Suggest a new Diagram Type to add to Mermaid.
|
|
labels:
|
|
- 'Status: Triage'
|
|
- 'Type: Enhancement'
|
|
- 'Type: New Diagram'
|
|
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |-
|
|
## Before you submit...
|
|
First of all, thank you for proposing a new Diagram to us.
|
|
We are always happy about new ideas to improve Mermaid.js wherever possible.
|
|
|
|
To get the fastest and best response possible, make sure you do the following:
|
|
|
|
- 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!
|
|
|
|
## Example issues
|
|
|
|
Refer to the discussions here to get an idea of how the diagram syntax is created.
|
|
|
|
- https://github.com/mermaid-js/mermaid/issues/4269
|
|
- https://github.com/mermaid-js/mermaid/issues/4282
|
|
|
|
- type: textarea
|
|
attributes:
|
|
label: Proposal
|
|
description: A clear and concise description of what should be added to Mermaid.js.
|
|
placeholder: Mermaid.js should add ... because ...
|
|
validations:
|
|
required: true
|
|
- type: textarea
|
|
attributes:
|
|
label: Use Cases
|
|
description: If applicable, give some use cases for where this diagram would be useful.
|
|
placeholder: The Diagram could be used for ...
|
|
- type: textarea
|
|
attributes:
|
|
label: Screenshots
|
|
description: If applicable, add screenshots to show possible examples of how the diagram may look like.
|
|
- type: textarea
|
|
attributes:
|
|
label: Syntax
|
|
description: |-
|
|
If possible, include a syntax which could be used to write the diagram.
|
|
Try to add one or two examples of valid use-cases here.
|
|
- type: dropdown
|
|
id: implementation
|
|
attributes:
|
|
label: Implementation
|
|
description: |-
|
|
Would you like to implement this yourself, or is it a proposal for the community?
|
|
If there is no corresponding PR from your side after 30 days, the diagram will be open for everyone to implement.
|
|
options:
|
|
- I will try and implement it myself.
|
|
- This is a proposal which I'd love to see built into mermaid by the wonderful community.
|