Skip to content

Commit 45d6173

Browse files
committed
Update contribution guidelines
1 parent 0d6f95a commit 45d6173

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

CONTRIBUTING.md

+17-9
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,23 @@ If you spot a typo or the content does not make sense in some way, feel free to
55
I am open for enhancement ideas and feature requests. If there's some topic you'd like to see a notebook about, feel free to open an issue and request it there.
66

77
## Development
8+
Install development dependencies
9+
```
10+
pip install -r dev-requirements.txt
11+
```
812

9-
#### post_save_hook
10-
* Copy the content of utils/post_save_hook.py to your jupyter_notebook_config.py before making changes to notebooks
11-
* This will setup a post_save_hook which will generate a html version of the notebook automatically when the notebook is saved
12-
* htmls are not generated for exercises
13+
#### Generating html
14+
```
15+
python scripts/notebook_to_html.py <path-to-ipynb-file>
16+
```
1317

1418
#### Testing
15-
* Travis CI will make sure that the code cells in the notebooks can be executed
16-
* You test the same locally by:
17-
* install tox by: `pip install tox`
18-
* run tox: `tox`
19-
* Tests are not run for exercises (because the code in the exercise cells is usually intentionally incomplete)
19+
```
20+
pytest --nbval notebooks
21+
```
22+
23+
#### pre-commit
24+
```
25+
pre-commit install
26+
```
27+
and it'll automatically run all the pre-commit hooks for each commit.

0 commit comments

Comments
 (0)