Skip to content

Commit 1e19529

Browse files
committed
update contributing with scripts etc
1 parent 9c14c01 commit 1e19529

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ open issue you want to work on, please leave a comment on it - assigned issues
55
are spearheaded by the assignee, if they need help they will coordinate on the
66
issue.
77

8-
## Development
8+
## Development Environment
99
This project uses `uv` and `pre-commit`.
1010
to install `uv`, you can use homebrew:
1111
```sh
@@ -19,3 +19,10 @@ Once `uv` is installed, clone this repo, then run the following:
1919
uv sync --locked --all-extras --dev # this installs all dev dependencies, without upgrading any.
2020
uv run pre-commit install # sets up pre-commit
2121
```
22+
23+
## Organization
24+
This project uses a `src` layout. all tests are in the `tests` directory, and can be
25+
run with `pytest` from root. the `scripts` directory contains useful scripts for
26+
debugging nodes, including a set of "auto" scripts (which runs normally and periodically
27+
prints the finger table), and "manual" scripts (which include a step function, to manually
28+
run one iteration of the daemon and print the result".

0 commit comments

Comments
 (0)