Skip to content

Commit 512c873

Browse files
committed
update dash-core-components/CONTRIBUTING
1 parent 4ed9279 commit 512c873

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

components/dash-core-components/CONTRIBUTING.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ you've pulled from upstream otherwise you may be running with an out of date
3131
`bundle.js`. See the instructions for building `bundle.js` in the [Testing
3232
Locally](README.md#testing-locally) section of README.md.
3333

34-
## Updating Plotly.js
34+
## Updating official version of Plotly.js
3535

36-
1. Update the version of `plotly.js` in package.json. Always use an exact version without "^" or "~"
36+
1. Update the version of `plotly.js-dist-min` in package.json. Always use an exact version without "^" or "~"
3737
2. Run `npm install` followed by `npm run build`, the Plotly.js artifact will be copied and bundled over as required
3838
4. Update `CHANGELOG.md` with links to the releases and a description of the changes. The message should state (see the existing `CHANGELOG.md` for examples):
3939
* If you're only bumping the patch level, the heading is "Fixed" and the text starts "Patched plotly.js". Otherwise the heading is "Updated" and the text starts "Upgraded plotly.js"
@@ -42,6 +42,11 @@ Locally](README.md#testing-locally) section of README.md.
4242
* All patch versions included, with links to their release pages and a note that these fix bugs
4343
5. When bumping the dcc version, a plotly.js patch/minor/major constitutes a dcc patch/minor/major respectively as well.
4444

45+
### Using a temporary `plotly.js-dist-min` package (or other dependencies)
46+
47+
> During integrated development of new features or bug fixes in plotly.js and dash, it may be required to install a temporary plotly.js-dist-min package (or other packages) including proposed changes. To do so, please place the `.tgz` file in `packages/` folder then `npm install` the file.
48+
49+
4550
## Financial Contributions
4651

4752
If your company wishes to sponsor development of open source dash components, please [get in touch][].

0 commit comments

Comments
 (0)