diff --git a/.github/ISSUE_TEMPLATE/syntaxt_proposal.yml b/.github/ISSUE_TEMPLATE/syntaxt_proposal.yml index 63bd4884d..b82b0eaa1 100644 --- a/.github/ISSUE_TEMPLATE/syntaxt_proposal.yml +++ b/.github/ISSUE_TEMPLATE/syntaxt_proposal.yml @@ -8,10 +8,15 @@ body: - type: markdown attributes: value: |- - Thank you for suggesting a new Syntax for Mermaid.js! + ## Before you submit... + First of all, thank you for proposing a new Syntax to us. + We are always happy about new ideas to improve Mermaid.js wherever possible. - We are always excited for new ideas to make the library more advanced and useful for people. - Please take your time to fill out the below sections with as much detail as you can. + 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. Examples are always welcome. + - Never be shy to give us screenshots and/or code samples. It will help! - type: textarea attributes: label: Proposal @@ -19,6 +24,10 @@ body: placeholder: Mermaid.js should add ... because ... validations: required: true + - type: textarea + attributes: + label: Example + description: If applicable, provide an example of the new Syntax. - type: textarea attributes: label: Screenshots