| 1 | name: Diagram Proposal |
| 2 | description: Suggest a new Diagram Type to add to Mermaid. |
| 3 | labels: |
| 4 | - 'Status: Triage' |
| 5 | - 'Type: Enhancement' |
| 6 | - 'Type: New Diagram' |
| 7 | |
| 8 | body: |
| 9 | - type: markdown |
| 10 | attributes: |
| 11 | value: |- |
| 12 | ## Before you submit... |
| 13 | First of all, thank you for proposing a new Diagram to us. |
| 14 | We are always happy about new ideas to improve Mermaid.js wherever possible. |
| 15 | |
| 16 | To get the fastest and best response possible, make sure you do the following: |
| 17 | |
| 18 | - Use a clear and concise title |
| 19 | - Fill out the text fields with as much detail as possible. |
| 20 | - Never be shy to give us screenshots and/or code samples. It will help! |
| 21 | |
| 22 | ## Example issues |
| 23 | |
| 24 | Refer to the discussions here to get an idea of how the diagram syntax is created. |
| 25 | |
| 26 | - https://github.com/mermaid-js/mermaid/issues/4269 |
| 27 | - https://github.com/mermaid-js/mermaid/issues/4282 |
| 28 | |
| 29 | - type: textarea |
| 30 | attributes: |
| 31 | label: Proposal |
| 32 | description: A clear and concise description of what should be added to Mermaid.js. |
| 33 | placeholder: Mermaid.js should add ... because ... |
| 34 | validations: |
| 35 | required: true |
| 36 | - type: textarea |
| 37 | attributes: |
| 38 | label: Use Cases |
| 39 | description: If applicable, give some use cases for where this diagram would be useful. |
| 40 | placeholder: The Diagram could be used for ... |
| 41 | - type: textarea |
| 42 | attributes: |
| 43 | label: Screenshots |
| 44 | description: If applicable, add screenshots to show possible examples of how the diagram may look like. |
| 45 | - type: textarea |
| 46 | attributes: |
| 47 | label: Syntax |
| 48 | description: |- |
| 49 | If possible, include a syntax which could be used to write the diagram. |
| 50 | Try to add one or two examples of valid use-cases here. |
| 51 | - type: dropdown |
| 52 | id: implementation |
| 53 | attributes: |
| 54 | label: Implementation |
| 55 | description: |- |
| 56 | Would you like to implement this yourself, or is it a proposal for the community? |
| 57 | If there is no corresponding PR from your side after 30 days, the diagram will be open for everyone to implement. |
| 58 | options: |
| 59 | - I will try and implement it myself. |
| 60 | - This is a proposal which I'd love to see built into mermaid by the wonderful community. |
| 61 | |