marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-14 12:59:46 +02:00
Code Issues Packages Projects Releases Wiki Activity

add mermaid diagram

Browse Source
This commit is contained in:
Ashley Engelund (weedySeaDragon @ github)
2022-11-15 05:14:58 -08:00
parent 548ae5b023
commit 535a1fc8cf
2 changed files with 17 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/community/development.md
View File

@@ -66,7 +66,17 @@ The `test` script and others are in the top-level `package.json` file.
The basic steps for contributing code are: The basic steps for contributing code are:
1. **Create** a git branch and work on your code in the branch ```mermaid-example
graph LR
git[1. Checkout a git branch] --> codeTest[2. write tests and code] --> doc[3. update documentation] --> submit[4.submit a PR]
```
```mermaid
graph LR
git[1. Checkout a git branch] --> codeTest[2. write tests and code] --> doc[3. update documentation] --> submit[4.submit a PR]
```
1. **Create** and checkout a git branch and work on your code in the branch
2. Write and update **tests** (unit and perhaps even integration (e2e) tests) (If you do TDD/BDD, the order might be different.) 2. Write and update **tests** (unit and perhaps even integration (e2e) tests) (If you do TDD/BDD, the order might be different.)
3. **Let users know** that things have changed or been added in the documents! This is often overlooked, but _critical_ 3. **Let users know** that things have changed or been added in the documents! This is often overlooked, but _critical_
4. **Submit** your code as a _pull request._ 4. **Submit** your code as a _pull request._
@@ -74,7 +84,6 @@ The basic steps for contributing code are:
### 1. Checkout a git branch ### 1. Checkout a git branch
Mermaid uses a [Git Flow](https://guides.github.com/introduction/flow/)–inspired approach to branching. Mermaid uses a [Git Flow](https://guides.github.com/introduction/flow/)–inspired approach to branching.
\[TODO - mermaid git diagram here]
Development is done in the `develop` branch. Development is done in the `develop` branch.

9
packages/mermaid/src/docs/community/development.md
View File

@@ -59,7 +59,12 @@ The `test` script and others are in the top-level `package.json` file.
The basic steps for contributing code are: The basic steps for contributing code are:
1. **Create** a git branch and work on your code in the branch ```mermaid
graph LR
git[1. Checkout a git branch] --> codeTest[2. write tests and code] --> doc[3. update documentation] --> submit[4.submit a PR]
```
1. **Create** and checkout a git branch and work on your code in the branch
2. Write and update **tests** (unit and perhaps even integration (e2e) tests) (If you do TDD/BDD, the order might be different.) 2. Write and update **tests** (unit and perhaps even integration (e2e) tests) (If you do TDD/BDD, the order might be different.)
3. **Let users know** that things have changed or been added in the documents! This is often overlooked, but _critical_ 3. **Let users know** that things have changed or been added in the documents! This is often overlooked, but _critical_
4. **Submit** your code as a _pull request._ 4. **Submit** your code as a _pull request._
@@ -67,7 +72,6 @@ The basic steps for contributing code are:
### 1. Checkout a git branch ### 1. Checkout a git branch
Mermaid uses a [Git Flow](https://guides.github.com/introduction/flow/)–inspired approach to branching. Mermaid uses a [Git Flow](https://guides.github.com/introduction/flow/)–inspired approach to branching.
[TODO - mermaid git diagram here]
Development is done in the `develop` branch. Development is done in the `develop` branch.
@@ -83,7 +87,6 @@ Once the release happens we merge the `release` branch with `master` and delete
2. Check out the `develop` branch 2. Check out the `develop` branch
3. Create a new branch for your work. Please name the branch following our naming convention below. 3. Create a new branch for your work. Please name the branch following our naming convention below.
We use the follow naming convention for branches: We use the follow naming convention for branches:
```text ```text