mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-11-17 11:14:12 +01:00
Update contributing.md
This commit is contained in:
@@ -13,6 +13,7 @@ Some important guidlines:
|
|||||||
|
|
||||||
The issue list and the items marked with **help wanted** is a good starting point if you want to do some work.
|
The issue list and the items marked with **help wanted** is a good starting point if you want to do some work.
|
||||||
|
|
||||||
|
|
||||||
## Guidelines for avoiding duplicate work
|
## Guidelines for avoiding duplicate work
|
||||||
|
|
||||||
Contributing is great. It is not so fun when you are done with your issue and just before you're about to push your
|
Contributing is great. It is not so fun when you are done with your issue and just before you're about to push your
|
||||||
@@ -26,6 +27,7 @@ place to prevent this:
|
|||||||
|
|
||||||
|
|
||||||
## Submitting changes
|
## Submitting changes
|
||||||
|
|
||||||
Please send a GitHub Pull Request with a clear list of what you've done (read more about pull requests). When you send
|
Please send a GitHub Pull Request with a clear list of what you've done (read more about pull requests). When you send
|
||||||
a pull request, we will love you forever if you include jasmine tests. We can always use more test coverage.
|
a pull request, we will love you forever if you include jasmine tests. We can always use more test coverage.
|
||||||
|
|
||||||
@@ -47,6 +49,7 @@ Also for the CDN, always use cwd-relative paths rather than root-relative paths
|
|||||||
url('/images/blah.gif'), use url('../images/blah.gif').
|
url('/images/blah.gif'), use url('../images/blah.gif').
|
||||||
|
|
||||||
# Build instructions
|
# Build instructions
|
||||||
|
|
||||||
Fork, then:
|
Fork, then:
|
||||||
|
|
||||||
```
|
```
|
||||||
@@ -63,14 +66,23 @@ for instance:
|
|||||||
```
|
```
|
||||||
gulp jison
|
gulp jison
|
||||||
```
|
```
|
||||||
|
|
||||||
|
To build:
|
||||||
|
|
||||||
|
```
|
||||||
|
yarn build
|
||||||
|
```
|
||||||
|
|
||||||
To run the tests:
|
To run the tests:
|
||||||
|
|
||||||
```
|
```
|
||||||
yarn run karma
|
yarn test
|
||||||
```
|
```
|
||||||
|
|
||||||
To build the /dist directory
|
Make sure you have Chrome browser installed. We use Chrome headless for testing.
|
||||||
```
|
|
||||||
yarn run dist
|
|
||||||
```
|
|
||||||
|
|
||||||
Thanks, Knut Sveidqvist
|
Manual test:
|
||||||
|
|
||||||
|
```
|
||||||
|
open dist/demo/index.html
|
||||||
|
```
|
||||||
|
|||||||
6
todo.md
6
todo.md
@@ -3,10 +3,8 @@
|
|||||||
- Problem is it's for d3 v4 only
|
- Problem is it's for d3 v4 only
|
||||||
- node console output colors like Chrome console
|
- node console output colors like Chrome console
|
||||||
- default theme doesn't work for class diagram
|
- default theme doesn't work for class diagram
|
||||||
- compile less to css
|
|
||||||
- don't version control generated content, move them to outside project
|
- don't version control generated content, move them to outside project
|
||||||
- editor
|
- editor
|
||||||
- dist
|
|
||||||
- docs
|
- docs
|
||||||
- what's the correct way to change logLevel as an end user?
|
- what's the correct way to change logLevel as an end user?
|
||||||
- d3 v3 doesn't support 'use strict'
|
- d3 v3 doesn't support 'use strict'
|
||||||
@@ -17,3 +15,7 @@
|
|||||||
- rewrite live editor
|
- rewrite live editor
|
||||||
- Fix Travis CI
|
- Fix Travis CI
|
||||||
- Fix CodeClimate
|
- Fix CodeClimate
|
||||||
|
- What is live-server ?
|
||||||
|
- Get familar with jison
|
||||||
|
- How to generate doc?
|
||||||
|
- webpack warning: lodash too big
|
||||||
|
|||||||
Reference in New Issue
Block a user