Skip to content

Commit 1b9619d

Browse files
committed
Fill in missing steps in CONTRIBUTING.md
1 parent 316b662 commit 1b9619d

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,13 @@ $ pip install -e .[testing,dev] # in some shells you need \ to escape []
1616
$ cd dash-renderer
1717
# build renderer bundles, this will build all bundles from source code
1818
# the only true source of npm version is defined in package.json
19+
$ npm install
1920
$ npm run build # or `renderer build`
2021
# install dash-renderer for development
2122
$ pip install -e .
2223
# build and install components used in tests
24+
$ cd .. # should be back in dash/ root directory
25+
$ npm install
2326
$ npm run setup-tests
2427
# you should see both dash and dash-renderer are pointed to local source repos
2528
$ pip list | grep dash
@@ -104,7 +107,7 @@ Note that we also start using [`black`](https://black.readthedocs.io/en/stable/)
104107

105108
## Tests
106109

107-
We started migrating to [pytest](https://docs.pytest.org/en/latest/) from `unittest` as our test automation framework. You will see more testing enhancements in the near future.
110+
We started migrating to [pytest](https://docs.pytest.org/en/latest/) from `unittest` as our test automation framework. You will see more testing enhancements in the near future. To run the tests, see the commands in the `package.json` (such as `npm run test.integration`)
108111

109112
### Unit Tests
110113

@@ -116,6 +119,8 @@ Note: *You might find out that we have more integration tests than unit tests in
116119

117120
We introduced the `dash.testing` feature in [Dash 1.0](https://community.plotly.com/t/announcing-dash-testing/24868). It makes writing a Dash integration test much easier. Please read the [tutorial](http://dash.plotly.com/testing) and add relevant integration tests with any new features or bug fixes.
118121

122+
To run the integration tests, you may have to [install circleci](https://circleci.com/docs/2.0/local-cli/).
123+
119124
## Financial Contributions
120125

121126
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.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
"private::lint.renderer": "cd dash-renderer && npm run lint",
1313
"private::test.setup-nested": "cd \\@plotly/dash-generator-test-component-nested && npm ci && npm run build && pip install -e .",
1414
"private::test.setup-standard": "cd \\@plotly/dash-generator-test-component-standard && npm ci && npm run build && pip install -e .",
15-
"private::test.unit-dash": "PYTHONPATH=~/dash/tests/assets pytest tests/unit",
15+
"private::test.unit-dash": "PYTHONPATH=tests/assets pytest tests/unit",
1616
"private::test.unit-renderer": "cd dash-renderer && npm run test",
1717
"private::test.integration-dash": "TESTFILES=$(circleci tests glob \"tests/integration/**/test_*.py\" | circleci tests split --split-by=timings) && pytest --headless --nopercyfinalize --junitxml=test-reports/junit_intg.xml ${TESTFILES}",
1818
"format": "run-s private::format.*",

0 commit comments

Comments
 (0)