📝🔧 start adressing recommendations from Sebastian, see #5

Author: enryH

Contributing.md

@@ -0,0 +1,36 @@
+# Contributing code
+
+Install the code with development dependencies:
+
+```bash
+pip install -e '.[dev]'
+```
+
+## Format code and sort imports
+
+```bash
+black .
+isort .
+```
+
+## lint code
+
+```bash
+ruff check .
+```
+
+## Run tests
+
+```bash
+pytest
+```
+
+## Sync notebooks with jupytext
+
+For easier diffs, you can use jupytext to sync notebooks in the `docs/tutorial` directory with the percent format.
+
+```bash
+jupytext --sync docs/tutorial/*.ipynb
+```
+
+This is configured in the [`.jupytext`](docs/tutorial/.jupytext) file in that directory.

docs/tutorial/.jupytext

@@ -1,2 +1,6 @@
-# all notebooks in this directory are in the percent format
+# all notebooks in this directory are synced percent format when typing
+# (jupytext is a dev dependency)
+# jupytext --sync *.ipynb
+# or from root directory
+# jupytext --sync docs/api_examples/*.ipynb
 formats = "ipynb,py:percent"

pyproject.toml

@@ -43,7 +43,7 @@ docs = [
   "sphinx-copybutton",
 ]
 # local development options
-dev = ["black[jupyter]", "ruff", "pytest"]
+dev = ["black[jupyter]", "ruff", "pytest", "isort", "jupytext"]
 
 [tool.ruff]
 # https://docs.astral.sh/ruff/rules/#flake8-bandit-s