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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+14-2
Original file line number
Diff line number
Diff line change
@@ -47,6 +47,7 @@ We use the following [labels](https://github.com/plotly/plotly.js/labels) to tra
47
47
|`type: feature`| planned feature additions |
48
48
|`type: performance`| performance related tasks |
49
49
|`type: maintenace`| source code cleanup resulting in no enhancement for users |
50
+
|`type: documentation`| API doc or attribute description improvements |
50
51
|`type: community`| issue left open for community input and pull requests |
51
52
|`type: duplicate`|*self-explanatory*|
52
53
|`type: wontfix`|*self-explanatory*|
@@ -72,7 +73,18 @@ cd plotly.js
72
73
npm install
73
74
```
74
75
75
-
#### Step 2: Start the test dashboard
76
+
#### Step 2: Setup Mapbox access token
77
+
78
+
As of `v1.13.0`, plotly.js includes a [`mapbox-gl`](https://github.com/mapbox/mapbox-gl-js) integration. Creating `mapbox-gl` graphs requires an
79
+
[`accessToken`](https://www.mapbox.com/help/define-access-token/). To make sure
80
+
that the plotly.js test suites and devtools work properly, locate your Mapbox access
81
+
token and run:
82
+
83
+
```bash
84
+
export MAPBOX_ACCESS_TOKEN="<your access token>"&& npm run pretest
85
+
```
86
+
87
+
#### Step 3: Start the test dashboard
76
88
77
89
```
78
90
npm start
@@ -84,7 +96,7 @@ This command bundles up the source files with source maps using
84
96
dev plotly.js bundle update every time a source file is saved) and opens up a
85
97
tab in your browser.
86
98
87
-
#### Step 3: Open up the console and start developing
99
+
#### Step 4: Open up the console and start developing
88
100
89
101
A typical workflow is to make some modifications to the source, update the
90
102
test dashboard, inspect and debug the changes, then repeat. The test dashboard
0 commit comments