Update contributing.md

This commit is contained in:
Tyler Long 2017-04-22 17:10:37 +08:00
parent 1927ed47ff
commit 7bb988c48b
2 changed files with 22 additions and 8 deletions

View File

@ -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.
## 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
@ -26,6 +27,7 @@ place to prevent this:
## 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
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').
# Build instructions
Fork, then:
```
@ -63,14 +66,23 @@ for instance:
```
gulp jison
```
To build:
```
yarn build
```
To run the tests:
```
yarn run karma
yarn test
```
To build the /dist directory
```
yarn run dist
```
Make sure you have Chrome browser installed. We use Chrome headless for testing.
Thanks, Knut Sveidqvist
Manual test:
```
open dist/demo/index.html
```

View File

@ -3,10 +3,8 @@
- Problem is it's for d3 v4 only
- node console output colors like Chrome console
- default theme doesn't work for class diagram
- compile less to css
- don't version control generated content, move them to outside project
- editor
- dist
- docs
- what's the correct way to change logLevel as an end user?
- d3 v3 doesn't support 'use strict'
@ -17,3 +15,7 @@
- rewrite live editor
- Fix Travis CI
- Fix CodeClimate
- What is live-server ?
- Get familar with jison
- How to generate doc?
- webpack warning: lodash too big