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

spelling: description; .. help us keep release notes organized

Browse Source 
Co-authored-by: Sidharth Vinod <sidharthv96@gmail.com>
This commit is contained in:
Ashley Engelund
2022-11-18 15:39:29 -08:00
committed by GitHub
parent 71d2175e19
commit 0333bc172c
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -110,7 +110,7 @@ We use the follow naming convention for branches:
- followed by an _underscore_ ('\_') - followed by an _underscore_ ('\_')
- followed by a short text description (but use dashes ('-') or underscores ('\_') instead of spaces) - followed by a short text description (but use dashes ('-') or underscores ('\_') instead of spaces)
If your work is specific to a single diagram type, it is a good idea to put the diagram type at the start of the dscription. This will help use keep release notes organized: it will help us keep changes for a diagram type together. If your work is specific to a single diagram type, it is a good idea to put the diagram type at the start of the description. This will help us keep release notes organized: it will help us keep changes for a diagram type together.
**Ex: A new feature described in issue 2945 that adds a new arrow type called 'florbs' to state diagrams** **Ex: A new feature described in issue 2945 that adds a new arrow type called 'florbs' to state diagrams**