Commit fcb99a5 1 parent 8d6af45 commit fcb99a5 Copy full SHA for fcb99a5
File tree 1 file changed +56
-0
lines changed
1 file changed +56
-0
lines changed Original file line number Diff line number Diff line change
1
+ # Contributing
2
+
3
+
4
+ ## Contributing code
5
+
6
+ We use [ uv] ( https://docs.astral.sh/uv/ ) to manage our development environment.
7
+
8
+
9
+ ### Setup
10
+
11
+ Setup your development environment by running:
12
+
13
+ ``` bash
14
+ uv lock
15
+ ```
16
+
17
+ Install pre-commit hook
18
+
19
+ ``` bash
20
+ uv run pre-commit install
21
+ ```
22
+
23
+ Start a IPython/Jupyter session by running:
24
+
25
+ ``` bash
26
+ uv run --with ipython ipython
27
+ # or
28
+ uv run --with jupyter jupyter lab
29
+ ```
30
+
31
+ ### Test
32
+
33
+ To run the tests, use:
34
+
35
+ ``` bash
36
+ uv run task test
37
+ ```
38
+
39
+ ### Documentation
40
+
41
+ To build the documentation, use:
42
+
43
+ ``` bash
44
+ # Build doc with cache
45
+ uv run task doc-build
46
+ # Fresh build
47
+ uv run task doc-clean-build
48
+ ```
49
+
50
+ To serve the documentation, use:
51
+
52
+ ``` bash
53
+ uv run task doc-serve
54
+ ```
55
+
56
+ This will start a local server at [ http://localhost:8000 ] ( http://localhost:8000 ) .
You can’t perform that action at this time.
0 commit comments