File tree Expand file tree Collapse file tree 1 file changed +69
-1
lines changed Expand file tree Collapse file tree 1 file changed +69
-1
lines changed Original file line number Diff line number Diff line change 1- yolos!
1+ # Contributing to plotly.js
2+
3+ ### Opening issues
4+
5+ Search for existing and closed issues. If your problem or idea is not addressed
6+ yet, [ please open a new issue] ( https://github.com/plotly/plotly.js/issues/new ) .
7+
8+ ### Development
9+
10+ ** Prerequisites** :
11+
12+ - git
13+ - [ node.js] ( https://nodejs.org/en/ ) . We recommend using node.js 4.2.1 (LTS).
14+ Upgrading and managing node versions can be easily done using
15+ [ ` nvm ` ] ( https://github.com/creationix/nvm ) or its Windows alternatives.
16+
17+ ** Step 1** Clone the plotly.js repo and install its dependencies
18+
19+ ```
20+ git clone https://github.com/plotly/plotly.js.git
21+ cd plotly.js
22+ npm install
23+ ```
24+
25+ ** Step 2** Build plotly.js
26+
27+ ```
28+ npm run build
29+ ```
30+
31+ The build script combines:
32+
33+ - ` npm run preprocess ` , which converts ` scss ` and ` svg ` assets to ` js ` and
34+ - ` npm run bundle ` , which runs
35+ [ browserify] ( https://github.com/substack/node-browserify ) on the source files
36+
37+ ** Step 3** Start test dashboard
38+
39+ ```
40+ npm run start-test_dashboard
41+ ```
42+
43+ This command bundles up the source files with source maps, starts
44+ [ watchify] ( https://github.com/substack/watchify ) file watcher (making the your
45+ dev plotly.js bundle update every time a source file is saved) and opens up
46+ a tab in your browser.
47+
48+ ### Testing
49+
50+ ```
51+ npm test
52+ ```
53+
54+ Jasmine tests are run in a browser using
55+ [ karma] ( https://github.com/karma-runner/karma )
56+
57+ ```
58+ npm run test-jasmine
59+ ```
60+
61+ Image pixel comparison tests are run in a docker container
62+
63+ ```
64+ npm run test-image
65+ ```
66+
67+ ### Repo organization
68+
69+ ### Coding style
You can’t perform that action at this time.
0 commit comments