From e14c172029d818211ea373d5a8aca3a206fbbc05 Mon Sep 17 00:00:00 2001
From: Uwe Schmitt <uwe.schmitt@id.ethz.ch>
Date: Fri, 24 Sep 2021 14:48:53 +0200
Subject: [PATCH] updated CONTRIBUTING.md

---
 CONTRIBUTING.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..ff4aaf7
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,27 @@
+# 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.
+
+## Upload course material gitlab.ethz.ch
+
+Use `update_course_repo.sh` to prepare official repository to be used during
+the workshop.  This script updates the official repository from the currently
+active branch.
-- 
GitLab