-
-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This reverts commit 47a83c7.
- Loading branch information
Showing
32 changed files
with
1,034 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# These are supported funding model platforms | ||
|
||
github: | ||
- knsv | ||
- sidharthv96 | ||
#patreon: # Replace with a single Patreon username | ||
#open_collective: # Replace with a single Open Collective username | ||
#ko_fi: # Replace with a single Ko-fi username | ||
#tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel | ||
#community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry | ||
#liberapay: # Replace with a single Liberapay username | ||
#issuehunt: # Replace with a single IssueHunt username | ||
#otechie: # Replace with a single Otechie username | ||
#custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
name: Bug Report | ||
description: Create a report to help us improve | ||
labels: | ||
- 'Status: Triage' | ||
- 'Type: Bug / Error' | ||
|
||
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: | ||
- 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 | ||
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 info below. | ||
Note that you only need to fill out the relevant section | ||
value: |- | ||
- Mermaid version: | ||
- Browser and Version: [Chrome, Edge, Firefox] | ||
- type: textarea | ||
attributes: | ||
label: Additional Context | ||
description: Anything else to add? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
blank_issues_enabled: true | ||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
name: Diagram Proposal | ||
description: Suggest a new Diagram Type to add to Mermaid. | ||
labels: | ||
- 'Status: Triage' | ||
- 'Type: Enhancement' | ||
|
||
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! | ||
- 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
name: Syntax Proposal | ||
description: Suggest a new Syntax to add to Mermaid.js. | ||
labels: | ||
- 'Status: Triage' | ||
- 'Type: Enhancement' | ||
|
||
body: | ||
- type: markdown | ||
attributes: | ||
value: |- | ||
## 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! | ||
- 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: Example | ||
description: If applicable, provide an example of the new Syntax. | ||
- type: textarea | ||
attributes: | ||
label: Screenshots | ||
description: If applicable, add screenshots to show possible examples of how the theme may look like. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
name: Theme Proposal | ||
description: Suggest a new theme to add to Mermaid.js. | ||
labels: | ||
- 'Status: Triage' | ||
- 'Type: Enhancement' | ||
|
||
body: | ||
- type: markdown | ||
attributes: | ||
value: |- | ||
## 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! | ||
- 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 | ||
- ... | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Screenshots | ||
description: If applicable, add screenshots to show possible examples of how the theme may look like. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
name: 'CodeQL config' | ||
paths-ignore: | ||
- dist | ||
- cypress |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
'Type: Bug / Error': 'bug/*' | ||
'Type: Enhancement': 'feature/*' | ||
'Type: Other': 'other/*' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
## :bookmark_tabs: Summary | ||
|
||
Brief description about the content of your PR. | ||
|
||
Resolves #<your issue id here> | ||
|
||
## :straight_ruler: Design Decisions | ||
|
||
Describe the way your implementation works or what design decisions you made if applicable. | ||
|
||
### :clipboard: Tasks | ||
|
||
Make sure you | ||
|
||
- [ ] :book: have read the [contribution guidelines](https://github.com/mermaid-js/mermaid/blob/develop/CONTRIBUTING.md) | ||
- [ ] :computer: have added unit/e2e tests (if appropriate) | ||
- [ ] :notebook: have added documentation (if appropriate) | ||
- [ ] :bookmark: targeted `develop` branch |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
name-template: '$NEXT_PATCH_VERSION' | ||
tag-template: '$NEXT_PATCH_VERSION' | ||
categories: | ||
- title: '🚀 Features' | ||
labels: | ||
- 'Type: Enhancement' | ||
- title: '🐛 Bug Fixes' | ||
labels: | ||
- 'Type: Bug / Error' | ||
- title: '🧰 Maintenance' | ||
label: 'Type: Other' | ||
change-template: '- $TITLE (#$NUMBER) @$AUTHOR' | ||
sort-by: title | ||
sort-direction: ascending | ||
branches: | ||
- develop | ||
exclude-labels: | ||
- 'Skip changelog' | ||
no-changes-template: 'This release contains minor changes and bugfixes.' | ||
template: | | ||
# Release Notes | ||
$CHANGES | ||
🎉 **Thanks to all contributors helping with this release!** 🎉 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# Number of days of inactivity before an issue becomes stale | ||
daysUntilStale: 60 | ||
# Number of days of inactivity before a stale issue is closed | ||
daysUntilClose: 14 | ||
# Issues with these labels will never be considered stale | ||
exemptLabels: | ||
- Retained | ||
# Label to use when marking an issue as stale | ||
staleLabel: Inactive | ||
# Comment to post when marking an issue as stale. Set to `false` to disable | ||
markComment: > | ||
This issue has been automatically marked as stale because it has not had | ||
recent activity. It will be closed if no further activity occurs. Thank you | ||
for your contributions. | ||
If you are still interested in this issue and it is still relevant you can comment to revive it. | ||
# Comment to post when closing a stale issue. Set to `false` to disable | ||
closeComment: > | ||
This issue has been been automatically closed due to a lack of activity. | ||
This is done to maintain a clean list of issues that the community is interested in developing. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
name: Build Vitepress docs | ||
|
||
on: | ||
pull_request: | ||
|
||
permissions: | ||
contents: read | ||
|
||
jobs: | ||
# Build job | ||
build: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v3 | ||
|
||
- uses: pnpm/action-setup@v2 | ||
|
||
- name: Setup Node.js | ||
uses: actions/setup-node@v3 | ||
with: | ||
cache: pnpm | ||
node-version: 18 | ||
|
||
- name: Install Packages | ||
run: pnpm install --frozen-lockfile | ||
|
||
- name: Run Build | ||
run: pnpm --filter mermaid run docs:build:vitepress |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
name: Build | ||
|
||
on: | ||
push: {} | ||
pull_request: | ||
types: | ||
- opened | ||
- synchronize | ||
- ready_for_review | ||
|
||
permissions: | ||
contents: read | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
strategy: | ||
matrix: | ||
node-version: [18.x] | ||
steps: | ||
- uses: actions/checkout@v3 | ||
|
||
- uses: pnpm/action-setup@v2 | ||
# uses version from "packageManager" field in package.json | ||
|
||
- name: Setup Node.js ${{ matrix.node-version }} | ||
uses: actions/setup-node@v3 | ||
with: | ||
cache: pnpm | ||
node-version: ${{ matrix.node-version }} | ||
|
||
- name: Install Packages | ||
run: | | ||
pnpm install --frozen-lockfile | ||
env: | ||
CYPRESS_CACHE_FOLDER: .cache/Cypress | ||
|
||
- name: Run Build | ||
run: pnpm run build | ||
|
||
- name: Upload Mermaid Build as Artifact | ||
uses: actions/upload-artifact@v3 | ||
with: | ||
name: mermaid-build | ||
path: packages/mermaid/dist | ||
|
||
- name: Upload Mermaid Mindmap Build as Artifact | ||
uses: actions/upload-artifact@v3 | ||
with: | ||
name: mermaid-mindmap-build | ||
path: packages/mermaid-mindmap/dist |
Oops, something went wrong.