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
+12-5Lines changed: 12 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,22 +38,30 @@ As of Dash 1.2, the renderer bundle and its peer dependencies can be packed and
38
38
3.`renderer bundles` parses the locked version JSON, copies all the peer dependencies into dash_renderer folder, bundles the renderer assets, and generates an `__init__.py` to map all the resources. There are also a list of helpful `scripts` property defined in `package.json` you might need to do some handy tasks like linting, syntax format with prettier, etc.
39
39
4.`renderer digest` computes the content hash of each asset in `dash_renderer` folder, prints out the result in logs, and dumps into a JSON file `digest.json`. Use this when you have a doubt about the current assets in `dash_renderer`, and compare it with previous result in one shot by this command.
40
40
5.`renderer build` runs 1, 2, 3, 4 in sequence as a complete build process from scratch.
41
-
6.`renderer watch` runs the webpack in watch mode, so any source code change triggers a rebuild. Use this if you are actively updating renderer code and you want to test your changes immediately.
41
+
6.`renderer build local` runs the same order as in 5 and also generates source maps for debugging purposes. You also need to install dash-renderer with editable mode: `pip install -e .`.
42
42
43
43
When a change in renderer code doesn't reflect in your browser as expected, this could be: confused bundle generation, caching issue in a browser, python package not in `editable` mode, etc. The new tool reduces the risk of bundle assets by adding the digest to help compare asset changes.
44
44
45
+
## Python 2 And 3 Compatibility
46
+
47
+
Writing Python 2/3 compatible code might be a challenging task for contributors used to working on one particular version, especially new learners who start directly with Python 3.
48
+
49
+
From the #892, we started to adopt `python-future` instead of `six` as our tool to better achieve the goal where we can mainly write Python 3 code and make it back-compatible in Python 2.7 (last Python 2 version Dash supports before it gets deprecated).
50
+
51
+
Please refer to [this list of idioms](https://python-future.org/compatible_idioms.html"https://python-future.org/compatible_idioms.html") for more details on working with `python-future`.
52
+
45
53
## Git
46
54
47
55
Use the [GitHub flow](https://guides.github.com/introduction/flow/) when proposing contributions to this repository (i.e. create a feature branch and submit a PR against the default branch).
48
56
49
57
### Organize your commits
50
58
51
-
For pull request with notable file changes or a big feature developmennt, we highly recommend to organize the commits in a logical manner, so it
59
+
For pull request with notable file changes or a big feature development, we highly recommend to organize the commits in a logical manner, so it
52
60
53
61
- makes a code review experience much more pleasant
54
62
- facilitates a possible cherry picking with granular commits
55
63
56
-
*an intutive[example](https://github.com/plotly/dash-core-components/pull/548) is worth a thousand words.*
64
+
*an intuitive[example](https://github.com/plotly/dash-core-components/pull/548) is worth a thousand words.*
57
65
58
66
#### Git Desktop
59
67
@@ -106,15 +114,14 @@ Note: *You might find out that we have more integration tests than unit tests in
106
114
107
115
We introduced the `dash.testing` feature in [Dash 1.0](https://community.plot.ly/t/announcing-dash-testing/24868). It makes writing a Dash integration test much easier. Please read the [tutorial](http://dash.plot.ly/testing) and add relevant integration tests with any new features or bug fixes.
108
116
109
-
110
117
## Financial Contributions
111
118
112
119
Dash, and many of Plotly's open source products, have been funded through direct sponsorship by companies. [Get in touch] about funding feature additions, consulting, or custom app development.
Copy file name to clipboardExpand all lines: dash-renderer/CHANGELOG.md
+7Lines changed: 7 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,13 @@
2
2
All notable changes to this project will be documented in this file.
3
3
This project adheres to [Semantic Versioning](http://semver.org/).
4
4
5
+
## [1.1.0] - 2019-09-17
6
+
### Added
7
+
-[#903](https://github.com/plotly/dash/pull/903) enables props edited by the user to persist across recreating the component or reloading the page. Components need to define three new props: `persistence`, `persisted_props`, and `persistence_type` as described in the lead comment of `src/persistence.js`. App developers then enable this behavior by, in the simplest case, setting `persistence: true` on the component. First use case is table, see [dash-table#566](https://github.com/plotly/dash-table/pull/566)
8
+
9
+
### Fixed
10
+
- Reduced about 55% of the dash-renderer packages size on **PyPI** by removing the source maps. To do more advanced debugging, the source maps needs to be generated from source code with `npm run build:local` and pip install in editable mode, i.e. `pip install -e .`[#910](https://github.com/plotly/dash/pull/910)
11
+
5
12
## [1.0.1] - 2019-08-27
6
13
- Clean all the binary assets in dash-renderer repo, add tool to build all the required bundles from fresh source code to avoid confusion of the assets and improve the release process. [#874](https://github.com/plotly/dash/pull/874)
0 commit comments