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
{{ message }}
This repository was archived by the owner on Jun 3, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+7-27Lines changed: 7 additions & 27 deletions
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,13 @@ Please lint any additions to react components with `npm run lint`. Rules defined
16
16
17
17
Use the [GitHub flow][] when proposing contributions to this repository (i.e. create a feature branch and submit a PR against the master branch).
18
18
19
+
## Making a Contribution
20
+
_For larger features, your contribution will have a higher likelihood of getting merged if you create an issue to discuss the changes that you'd like to make before you create a pull request._
21
+
22
+
1. Create a pull request.
23
+
2. After a review has been done and your changes have been approved, they will be merged and included in a future release of Dash.
24
+
3. If significant enough, you have created an issue about documenting the new feature or change and you have added it to the [dash-docs](https://github.com/plotly/dash-docs) project.
25
+
19
26
## Running the Tests
20
27
21
28
In order to run the tests, you first need to have built the JavaScript
@@ -24,33 +31,6 @@ you've pulled from upstream otherwise you may be running with an out of date
24
31
`bundle.js`. See the instructions for building `bundle.js` in the [Testing
25
32
Locally](README.md#testing-locally) section of README.md.
26
33
27
-
## Publishing New Components/Features
28
-
29
-
For now, multiple steps are necessary for publishing to NPM and PyPi,
30
-
respectively. TODO:
31
-
[#5](https://github.com/plotly/dash-components-archetype/issues/5) will roll up publishing steps into one workflow.
32
-
33
-
1. Create a pull request and tag the Plotly team (`@plotly/dash`) as well as an appropriate reviewer (frequent [contributors][] are a safe bet).
34
-
2. After a review has been done and your changes have been approved, create a prerelease and comment in the PR. Version numbers should follow [semantic versioning][]. To create a prerelease:
35
-
* Add `rc1` to `version.py` (`./dash_core_components/version.py`) e.g. `0.13.0rc1`
36
-
* Add `-rc1` to `package.json` e.g. `0.13.0-rc1`
37
-
* Update the `unpkg` link in `./dash_core_components/__init__.py`, replacing `__version__` with your release candidate (e.g. `"0.13.0-rc1"`)
38
-
* Run `npm run publish-all`.
39
-
- If needed, ask @chriddyp to get NPM / PyPi package publishing access.
40
-
- If the `publish-all` script fails on the `twine` command, try running
41
-
```sh
42
-
twine upload dist/dash_core_components-X.X.X.tar.gz # where xx.x.x is the version number
43
-
```
44
-
3. Comment in the PR with the prerelease version
45
-
4. Update the top-level comment to include info about how to install, a summary of the changes, and a simple example. For a good example, see the [Confirmation Modal component][].
46
-
* This makes it easier fora community member to comein and try it out. As more folks review, it's harder to find the installation instructions deep in the PR
47
-
* Keep this top-level comment updated with installation instructions (e.g. the `pip install` command)
48
-
5. Make a post in the [Dash Community Forum][]
49
-
* Title it `":mega: Announcement! New <Your Feature> - Feedback Welcome"`
50
-
* In the description, link to the PR and any relevant issue(s)
51
-
* Pin the topic so that it appears at the top of the forum for two weeks
52
-
* For a good example, see the [Confirmation Modal announcement][]
53
-
54
34
## Updating Plotly.js
55
35
56
36
1. Download the latest plotly.js from the cdn: `$ wget https://github.com/plotly/plotly.js/releases/tag/v1.49.4`
0 commit comments