You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We use the following [labels](https://github.com/plotly/plotly.js/labels) to track issues:
20
20
@@ -32,24 +32,24 @@ We use the following [labels](https://github.com/plotly/plotly.js/labels) to tra
32
32
|`status: reviewable`| PRs that are completed from the author's perspective |
33
33
|`status: on hold`| PRs that are put on hold |
34
34
35
-
###Development
35
+
## Development
36
36
37
-
**Prerequisites**:
37
+
##### Perequisites
38
38
39
39
- git
40
40
-[node.js](https://nodejs.org/en/). We recommend using node.js 4.2.x (LTS).
41
41
Upgrading and managing node versions can be easily done using
42
42
[`nvm`](https://github.com/creationix/nvm) or its Windows alternatives.
43
43
44
-
**Step 1** Clone the plotly.js repo and install its dependencies
44
+
##### Step 1: Clone the plotly.js repo and install its dependencies
45
45
46
46
```
47
47
git clone https://github.com/plotly/plotly.js.git
48
48
cd plotly.js
49
49
npm install
50
50
```
51
51
52
-
**Step 2** Start the test dashboard
52
+
##### Step 2: Start the test dashboard
53
53
54
54
```
55
55
npm start
@@ -90,14 +90,14 @@ Three additional helpers exist that are refreshed every second:
90
90
There is also a search bar in the top right of the dashboard. This fuzzy-searches
91
91
image mocks based on their file name and trace type.
92
92
93
-
**Other npm scripts**:
93
+
##### Other npm scripts
94
94
95
95
-`npm run preprocess`: pre-processes the css and svg source file in js. This
96
96
script must be run manually when updating the css and svg source files.
97
97
-`npm run watch`: starts a watchify file watcher just like the test dashboard but
98
98
without booting up a server.
99
99
100
-
###Testing
100
+
## Testing
101
101
102
102
Both jasmine and image tests are run on
103
103
[CircleCI](https://circleci.com/gh/plotly/plotly.js) on every push to this
@@ -126,7 +126,7 @@ which shows the baseline image, the generated image, the diff and the json mocks
126
126
To view the results of a run on CircleCI, download the `build/test_images/` and `build/test_images_diff/` artifacts into your local repo and then run `npm run start-image_viewer`.
127
127
128
128
129
-
###Repo organization
129
+
## Repo organization
130
130
131
131
- Distributed files are in `dist/`
132
132
- CommonJS require-able modules are in `lib/`
@@ -138,7 +138,7 @@ To view the results of a run on CircleCI, download the `build/test_images/` and
138
138
- Non-distributed, built files are in `build/` (most files in here are git-ignored, the css and font built files are exceptions)
0 commit comments