From 2bcae96d0a138f01b1b3fef58842f1488029b1bd Mon Sep 17 00:00:00 2001 From: Andre_601 Date: Wed, 16 Feb 2022 21:35:33 +0100 Subject: [PATCH 01/15] Create config.yml --- .github/ISSUE_TEMPLATE/config.yml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..89023b3c8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: +# - name: GitHub Discussions +# url: https://github.com/mermaid-js/mermaid/discussions +# about: Ask the Community questions or share your own graphs in our discussions. + - name: Slack + url: https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE + about: Join our Community on Slack for Help and a casual chat. + - name: Documentation + url: https://mermaid-js.github.io + about: Read our documentation for all that Mermaid.js can offer. + - name: Live Editor + url: https://mermaid.live + about: Try the live editor to preview graphs in no time. From 8a5d9bbad3113ac29bbd6a2a819645b6051191f4 Mon Sep 17 00:00:00 2001 From: Andre_601 Date: Wed, 16 Feb 2022 21:51:02 +0100 Subject: [PATCH 02/15] Switch to bug_report.yml --- .github/ISSUE_TEMPLATE/bug_report.md | 41 ------------------- .github/ISSUE_TEMPLATE/bug_report.yml | 59 +++++++++++++++++++++++++++ 2 files changed, 59 insertions(+), 41 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 74e02e6cb..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: 'Status: Triage, Type: Bug / Error' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Code Sample** -If applicable, add the code sample or a link to the [live editor](https://mermaid-js.github.io/mermaid-live-editor). - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..42888ff0a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,59 @@ +name: Bug Report +description: Create a report to help us improve +labels: + - "Status: Triage" + - "Type: Bug / Error" + +body: + - 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: |- + If applicable, add the code sample or a link to the [Live Editor](https://mermaid.live). + Any text pasted here will be rendered as a Code block. + render: text + - type: textarea + attributes: + label: Setup + description: |- + Please fill out the below info. + Note that you only need to fill out one and not both sections. + value: |- + **Desktop** + + - OS and Version: [Windows, Linux, Mac, ...] + - Browser and Version: [Chrome, Edge, Firefox] + + **Smartphone** + + - Device: [Samsung, iPhone, ...] + - OS and Version: [Android, iOS, ...] + - Browser and Version: [Chrome, Safari, ...] + validations: + required: true + - type: textarea + attributes: + label: Additional Context + description: Anything else to add? From 15ac2f87a3cd839a5a6e01162334d2871386e6e7 Mon Sep 17 00:00:00 2001 From: Andre_601 Date: Wed, 16 Feb 2022 22:01:00 +0100 Subject: [PATCH 03/15] Create diagram_proposal.yml --- .github/ISSUE_TEMPLATE/diagram_proposal.yml | 37 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ----------- 2 files changed, 37 insertions(+), 20 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/diagram_proposal.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/diagram_proposal.yml b/.github/ISSUE_TEMPLATE/diagram_proposal.yml new file mode 100644 index 000000000..67e8434be --- /dev/null +++ b/.github/ISSUE_TEMPLATE/diagram_proposal.yml @@ -0,0 +1,37 @@ +name: Diagram Proposal +description: Suggest a new Diagram Type to add to Mermaid. +labels: + - "Status: Triage" + - "Type: Enhancement" + +body: + - type: markdown + attributes: + value: |- + Thank you for suggesting a new Diagram type for Mermaid.js! + + 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. + - 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: Code Sample + description: |- + If applicable, add a code sample for how to implement this new diagram. + The text will automatically be rendered as JavaScript code. + render: javascript diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index f79a30928..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: 'Status: Triage, Type: Enhancement' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. From 036dc802dc40904a3b14340295cfd5c395a47fad Mon Sep 17 00:00:00 2001 From: Andre_601 Date: Wed, 16 Feb 2022 22:07:25 +0100 Subject: [PATCH 04/15] Create theme_proposal.yml --- .github/ISSUE_TEMPLATE/theme_proposal.yml | 35 +++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/theme_proposal.yml diff --git a/.github/ISSUE_TEMPLATE/theme_proposal.yml b/.github/ISSUE_TEMPLATE/theme_proposal.yml new file mode 100644 index 000000000..c8e112043 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/theme_proposal.yml @@ -0,0 +1,35 @@ +name: Theme Proposal +description: Suggest a new theme to add to Mermaid.js. +labels: + - "Status: Triage" + - "Type: Enhancement" + +body: + - type: markdown + attributes: + value: |- + Thank you for suggesting a new Theme for Mermaid.js! + + 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. + - type: textarea + attributes: + label: Proposal + description: A clear and concise description of what theme should be added to Mermaid.js. + placeholder: Mermaid.js should add ... because ... + validations: + required: true + - type: textarea + attributes: + label: Colors + description: |- + A detailed list of the different colour values to use. + A list of currently used variable names can be found [here](https://mermaid-js.github.io/mermaid/#/theming?id=theme-variables-reference-table) + placeholder: |- + - background: #f4f4f4 + - primaryColor: #fff4dd + - ... + - type: textarea + attributes: + label: Screenshots + description: If applicable, add screenshots to show possible examples of how the theme may look like. From 96395c44e02fe27165ba356eba257ee15e9eb6e1 Mon Sep 17 00:00:00 2001 From: Andre_601 Date: Wed, 16 Feb 2022 22:08:43 +0100 Subject: [PATCH 05/15] Create syntaxt_proposal.yml --- .github/ISSUE_TEMPLATE/syntaxt_proposal.yml | 25 +++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/syntaxt_proposal.yml diff --git a/.github/ISSUE_TEMPLATE/syntaxt_proposal.yml b/.github/ISSUE_TEMPLATE/syntaxt_proposal.yml new file mode 100644 index 000000000..63bd4884d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/syntaxt_proposal.yml @@ -0,0 +1,25 @@ +name: Syntax Proposal +description: Suggest a new Syntax to add to Mermaid.js. +labels: + - "Status: Triage" + - "Type: Enhancement" + +body: + - type: markdown + attributes: + value: |- + Thank you for suggesting a new Syntax for Mermaid.js! + + 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. + - type: textarea + attributes: + label: Proposal + description: A clear and concise description of what Syntax should be added to Mermaid.js. + placeholder: Mermaid.js should add ... because ... + validations: + required: true + - type: textarea + attributes: + label: Screenshots + description: If applicable, add screenshots to show possible examples of how the theme may look like. From 33903bbf6d06e29a83e4581de4c68b06a816aa0b Mon Sep 17 00:00:00 2001 From: Andre_601 Date: Wed, 16 Feb 2022 22:10:24 +0100 Subject: [PATCH 06/15] Delete question.md --- .github/ISSUE_TEMPLATE/question.md | 15 --------------- 1 file changed, 15 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index 4f7444aa8..000000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -name: Question -about: Get some help from the community. -title: '' -labels: 'Help wanted!, Type: Other' -assignees: '' - ---- - -## Help us help you! -You want an answer. Here are some ways to get it quicker: -* Use a clear and concise title. -* Try to pose a clear and concise question. -* Include as much, or as little, code as necessary. -* Don't be shy to give us some screenshots, if it helps! From 56c2f23393ae048a0b1b61ec1a88bd639fcfa286 Mon Sep 17 00:00:00 2001 From: Andre_601 Date: Wed, 16 Feb 2022 22:14:21 +0100 Subject: [PATCH 07/15] Update bug_report.yml --- .github/ISSUE_TEMPLATE/bug_report.yml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 42888ff0a..cb6a94b2f 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -5,6 +5,15 @@ labels: - "Type: Bug / Error" body: + - type: markdown + attributes: + value: |- + ## Before you submit... + We like to help you, but in order to do that should you make a few things first: + + - 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! - type: textarea attributes: label: Description From 0f092acec3cbddd28aead697e287cd1f7e7756e7 Mon Sep 17 00:00:00 2001 From: Andre_601 Date: Wed, 16 Feb 2022 22:16:13 +0100 Subject: [PATCH 08/15] Update diagram_proposal.yml --- .github/ISSUE_TEMPLATE/diagram_proposal.yml | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/diagram_proposal.yml b/.github/ISSUE_TEMPLATE/diagram_proposal.yml index 67e8434be..2090c7c08 100644 --- a/.github/ISSUE_TEMPLATE/diagram_proposal.yml +++ b/.github/ISSUE_TEMPLATE/diagram_proposal.yml @@ -8,10 +8,15 @@ body: - type: markdown attributes: value: |- - Thank you for suggesting a new Diagram type for Mermaid.js! + ## 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. - 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. + - Never be shy to give us screenshots and/or code samples. It will help! - type: textarea attributes: label: Proposal From 9e0c5d1d145b674f03aebdd142cfd8950a807406 Mon Sep 17 00:00:00 2001 From: Andre_601 Date: Wed, 16 Feb 2022 22:17:54 +0100 Subject: [PATCH 09/15] Update syntaxt_proposal.yml --- .github/ISSUE_TEMPLATE/syntaxt_proposal.yml | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) 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 From 13286f66fd63119ef48e338f8125766ca09908a7 Mon Sep 17 00:00:00 2001 From: Andre_601 Date: Wed, 16 Feb 2022 22:18:47 +0100 Subject: [PATCH 10/15] Update theme_proposal.yml --- .github/ISSUE_TEMPLATE/theme_proposal.yml | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/theme_proposal.yml b/.github/ISSUE_TEMPLATE/theme_proposal.yml index c8e112043..920f9af3e 100644 --- a/.github/ISSUE_TEMPLATE/theme_proposal.yml +++ b/.github/ISSUE_TEMPLATE/theme_proposal.yml @@ -8,10 +8,15 @@ body: - type: markdown attributes: value: |- - Thank you for suggesting a new Theme for Mermaid.js! + ## Before you submit... + First of all, thank you for proposing a new Theme 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 From 979a3768558ce2e4dd13e2543a5f8cfe2f36e851 Mon Sep 17 00:00:00 2001 From: Andre_601 Date: Thu, 15 Sep 2022 01:28:20 +0200 Subject: [PATCH 11/15] make setup not required --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index cb6a94b2f..400a61138 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -60,8 +60,6 @@ body: - Device: [Samsung, iPhone, ...] - OS and Version: [Android, iOS, ...] - Browser and Version: [Chrome, Safari, ...] - validations: - required: true - type: textarea attributes: label: Additional Context From 612a57bdf71bb99b3c8fdd1feaabda0311c1684f Mon Sep 17 00:00:00 2001 From: Andre_601 Date: Thu, 15 Sep 2022 01:28:59 +0200 Subject: [PATCH 12/15] Make colors required --- .github/ISSUE_TEMPLATE/theme_proposal.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/theme_proposal.yml b/.github/ISSUE_TEMPLATE/theme_proposal.yml index 920f9af3e..304d1d1c9 100644 --- a/.github/ISSUE_TEMPLATE/theme_proposal.yml +++ b/.github/ISSUE_TEMPLATE/theme_proposal.yml @@ -34,6 +34,8 @@ body: - background: #f4f4f4 - primaryColor: #fff4dd - ... + validations: + required: true - type: textarea attributes: label: Screenshots From fe9a1c59cb16f4ec495df042f46cbd3c33d3f363 Mon Sep 17 00:00:00 2001 From: Andre_601 Date: Thu, 15 Sep 2022 01:39:57 +0200 Subject: [PATCH 13/15] Discussions are now available --- .github/ISSUE_TEMPLATE/config.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 89023b3c8..8710d49aa 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,8 +1,8 @@ blank_issues_enabled: false contact_links: -# - name: GitHub Discussions -# url: https://github.com/mermaid-js/mermaid/discussions -# about: Ask the Community questions or share your own graphs in our discussions. + - name: GitHub Discussions + url: https://github.com/mermaid-js/mermaid/discussions + about: Ask the Community questions or share your own graphs in our discussions. - name: Slack url: https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE about: Join our Community on Slack for Help and a casual chat. From ec10316346cbc209621de46b774a68b0503b57ce Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Sun, 30 Oct 2022 00:07:12 +0530 Subject: [PATCH 14/15] chore: lint --- .github/ISSUE_TEMPLATE/bug_report.yml | 12 ++++++------ .github/ISSUE_TEMPLATE/diagram_proposal.yml | 8 ++++---- .github/ISSUE_TEMPLATE/syntaxt_proposal.yml | 8 ++++---- .github/ISSUE_TEMPLATE/theme_proposal.yml | 8 ++++---- 4 files changed, 18 insertions(+), 18 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 400a61138..6ce66a831 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,8 +1,8 @@ name: Bug Report description: Create a report to help us improve labels: - - "Status: Triage" - - "Type: Bug / Error" + - 'Status: Triage' + - 'Type: Bug / Error' body: - type: markdown @@ -10,7 +10,7 @@ body: value: |- ## Before you submit... We like to help you, but in order to do that should you make a few things first: - + - 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! @@ -51,12 +51,12 @@ body: Note that you only need to fill out one and not both sections. value: |- **Desktop** - + - OS and Version: [Windows, Linux, Mac, ...] - Browser and Version: [Chrome, Edge, Firefox] - + **Smartphone** - + - Device: [Samsung, iPhone, ...] - OS and Version: [Android, iOS, ...] - Browser and Version: [Chrome, Safari, ...] diff --git a/.github/ISSUE_TEMPLATE/diagram_proposal.yml b/.github/ISSUE_TEMPLATE/diagram_proposal.yml index 2090c7c08..67dad5d3a 100644 --- a/.github/ISSUE_TEMPLATE/diagram_proposal.yml +++ b/.github/ISSUE_TEMPLATE/diagram_proposal.yml @@ -1,8 +1,8 @@ name: Diagram Proposal description: Suggest a new Diagram Type to add to Mermaid. labels: - - "Status: Triage" - - "Type: Enhancement" + - 'Status: Triage' + - 'Type: Enhancement' body: - type: markdown @@ -11,9 +11,9 @@ body: ## 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! diff --git a/.github/ISSUE_TEMPLATE/syntaxt_proposal.yml b/.github/ISSUE_TEMPLATE/syntaxt_proposal.yml index b82b0eaa1..99250ba93 100644 --- a/.github/ISSUE_TEMPLATE/syntaxt_proposal.yml +++ b/.github/ISSUE_TEMPLATE/syntaxt_proposal.yml @@ -1,8 +1,8 @@ name: Syntax Proposal description: Suggest a new Syntax to add to Mermaid.js. labels: - - "Status: Triage" - - "Type: Enhancement" + - 'Status: Triage' + - 'Type: Enhancement' body: - type: markdown @@ -11,9 +11,9 @@ body: ## 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. - + 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! diff --git a/.github/ISSUE_TEMPLATE/theme_proposal.yml b/.github/ISSUE_TEMPLATE/theme_proposal.yml index 304d1d1c9..da4fddbec 100644 --- a/.github/ISSUE_TEMPLATE/theme_proposal.yml +++ b/.github/ISSUE_TEMPLATE/theme_proposal.yml @@ -1,8 +1,8 @@ name: Theme Proposal description: Suggest a new theme to add to Mermaid.js. labels: - - "Status: Triage" - - "Type: Enhancement" + - 'Status: Triage' + - 'Type: Enhancement' body: - type: markdown @@ -11,9 +11,9 @@ body: ## Before you submit... First of all, thank you for proposing a new Theme 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. Examples are always welcome! - Never be shy to give us screenshots and/or code samples. It will help! From c46a3b09b1e8fdf5708c81f13462efce66cd2e50 Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Thu, 3 Nov 2022 10:53:15 +0530 Subject: [PATCH 15/15] Add Security Policy --- .github/ISSUE_TEMPLATE/bug_report.yml | 3 +++ .github/ISSUE_TEMPLATE/config.yml | 3 +++ .../{syntaxt_proposal.yml => syntax_proposal.yml} | 0 3 files changed, 6 insertions(+) rename .github/ISSUE_TEMPLATE/{syntaxt_proposal.yml => syntax_proposal.yml} (100%) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 6ce66a831..3ddf86ea5 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -8,6 +8,9 @@ body: - type: markdown attributes: value: |- + ## 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. + ## Before you submit... We like to help you, but in order to do that should you make a few things first: diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 8710d49aa..7f5a28fad 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -3,6 +3,9 @@ contact_links: - name: GitHub Discussions url: https://github.com/mermaid-js/mermaid/discussions about: Ask the Community questions or share your own graphs in our discussions. + - name: Security Vulnerability + url: https://github.com/mermaid-js/.github/blob/main/SECURITY.md + about: Report security issues - name: Slack url: https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE about: Join our Community on Slack for Help and a casual chat. diff --git a/.github/ISSUE_TEMPLATE/syntaxt_proposal.yml b/.github/ISSUE_TEMPLATE/syntax_proposal.yml similarity index 100% rename from .github/ISSUE_TEMPLATE/syntaxt_proposal.yml rename to .github/ISSUE_TEMPLATE/syntax_proposal.yml