Skip to content

Commit 7f3712f

Browse files
committed
Add development instructions
1 parent bb1d556 commit 7f3712f

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,18 @@
22

33
If you spot a typo or the content does not make sense in some way, feel free to open an issue or directly create a PR.
44

5-
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.
5+
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.
6+
7+
## Development
8+
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+
14+
#### 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)

0 commit comments

Comments
 (0)