mirrors
/
mermaid
mirror of https://github.com/mermaid-js/mermaid.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fix typos in CONTRIBUTING.md

This commit is contained in:
abeaton 2019-10-18 09:41:51 -04:00 committed by Nacho
parent 153b3322a6
commit 137f57ad9c
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
CONTRIBUTING.md
View File

@ -11,7 +11,7 @@ Here are a few things to know to get you started on the right path.
We make all changes via pull requests. As we have many pull requests from developers new to mermaid, the current approach is to have *knsv, Knut Sveidqvist* as a main reviewer of changes and merging pull requests. More precisely like this:
* Large changes reviewed by knsv or other developer asked to review by knsv
* Smaller low-risk changes like dependecies, documentation etc can be nerged by active collaborators
* Smaller low-risk changes like dependecies, documentation etc can be merged by active collaborators
* documentation (updates to the docs folder is also allowed via direct commits)
To commit code, create a branch, let it start with the type like feature or bug followed by the issue number for reference and some describing text.
@ -30,9 +30,9 @@ Less strict here, it is ok to commit directly in the develop branch if you are a
## Branching
Going forward we will use a git flow inspired approach branching. So development is done in develop,to do the development in the develop.
Going forward we will use a git flow inspired approach to branching. So development is done in develop, to do the development in the develop.
Once devlopment is done we branch a release branch from develop for testing.
Once development is done we branch a release branch from develop for testing.
Once the release happens we merge the release branch to master and kill the release branch.
@ -44,13 +44,13 @@ A new feature has been born. Great! But without the steps below it might just ..
### **Add unit tests for the parsing part**
This is important so that, if someone else does a change to the grammar that does not know about this great feature, gets notified early on when that a change breaks the parser. Another important aspect is that without proper parsing tests refactoring is pretty much impossible.
This is important so that, if someone else does a change to the grammar that does not know about this great feature, gets notified early on when that change breaks the parser. Another important aspect is that without proper parsing tests refactoring is pretty much impossible.
### **Add e2e tests**
This tests the rendering and visual apearance if the diagram. This ensures that the rendering of that feature in the e2e will be reviewed in the release process going forward. Less chans that it breaks!
This tests the rendering and visual apearance of the diagram. This ensures that the rendering of that feature in the e2e will be reviewed in the release process going forward. Less chance that it breaks!
To start working with the e2e tests, run `yarn dev`to start the dev server, after thar start cypress by running `cypress open`in the mermaid folder. (Make sure you have path to cypress in order, the binary is located in node_modules/.bin).
To start working with the e2e tests, run `yarn dev` to start the dev server, after that start cypress by running `cypress open` in the mermaid folder. (Make sure you have path to cypress in order, the binary is located in node_modules/.bin).
The rendering tests are very straightforward to create. There is a function imgSnapshotTest. This function takes a diagram in text form, the mermaid options and renders that diagram in cypress.
@ -82,7 +82,7 @@ This is what a rendering test looks like:
### **Add documentation for it**
Finally, if it is not in the documentation, no one will now about it and then **no one will use it**. Wouldn't that be sad? With all effort that was put into the feature?
Finally, if it is not in the documentation, no one will know about it and then **no one will use it**. Wouldn't that be sad? With all the effort that was put into the feature?
The docs are located in the docs folder and are ofc written in markdown. Just pick the right section and start typing. If you want to add to the structure as in adding a new section and new file you do that via the _navbar.md.
@ -90,7 +90,7 @@ The changes in master is reflected in http://knsv.github.io/mermaid/ once releas
## Last words
Don't get daunted if it is hard in the beginning. We have a great community with only enouraging words. So if you get stuck, ask for help and hints in the slack forum. If you want to show off something good, show it off there.
Don't get daunted if it is hard in the beginning. We have a great community with only encouraging words. So if you get stuck, ask for help and hints in the slack forum. If you want to show off something good, show it off there.
[Join our slack community if you want closer contact!](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE)