From aff5324e7d2ffde47a0dac157b51b2b971af0379 Mon Sep 17 00:00:00 2001 From: Mikolaj Rybinski <mikolaj.rybinski@id.ethz.ch> Date: Fri, 17 Sep 2021 15:53:34 +0200 Subject: [PATCH] Added CONTRIBUTING.md --- CONTRIBUTING.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4dfba6f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,21 @@ +# Contributing + +Install Python version matching one specified in `binder/runtime.txt`. + +Setup development environment: + + $ python -m venv .venv + $ source .venv/bin/activate + $ pip install -U pip setuptools + $ pip install -r binder/requirements.txt + $ ./binder/postBuild + +Register Git hooks (auto-remove output cells on commit): + + $ git config core.hooksPath .hooks + +Launch JupyterLab: + + $ jupyter lab + +Edit (improve) notebooks. -- GitLab