We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent b98040e commit a374b14Copy full SHA for a374b14
CONTRIBUTING.md
@@ -0,0 +1,44 @@
1
+# Contributing
2
+
3
+We now use [uv](https://docs.astral.sh/uv/) to manage our development environment.
4
5
+## Setup
6
7
+Setup your development environment by running:
8
9
+```bash
10
+uv lock
11
+uv run pre-commit install
12
+```
13
14
+Start a IPython/Jupyter session by running:
15
16
17
+uv run --with ipython ipython
18
+# or
19
+uv run --with jupyter jupyter lab
20
21
22
+## Test
23
+To run the tests, use:
24
25
26
+uv run task test
27
28
29
+## Documentation
30
31
+To build the documentation, use:
32
33
34
+# Build doc with cache
35
+uv run task doc-build
36
+# Fresh build
37
+uv run task doc-clean-build
38
39
40
+To serve the documentation, use:
41
42
43
+uv run task doc-serve
44
0 commit comments