Skip to content

Commit 4217f9d

Browse files
committed
docs: add some more contributing info
1 parent 8a04568 commit 4217f9d

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,24 @@
33
First off, thanks for contributing!
44
We appreciates you.
55

6+
## Relationship to **stac-utils/rustac**
7+
8+
[stac-utils/rustac](https://github.com/stac-utils/rustac) is a Rust monorepo that provides _most_ of the functionality of this Python package.
9+
It's pretty common that a bug in **rustac-py** is actually a bug in **rustac**.
10+
Knowing which repository to work in can be a little tricky, so don't hesitate to reach out and ask.
11+
12+
## Python environment
13+
14+
It can be a little tricky to ensure that your Python environment is always up-to-date while developing a Rust+Python project.
15+
We're still figuring out the _best_ way, but for now, try this:
16+
17+
```shell
18+
uv sync
19+
python -m maturin_import_hook site install
20+
```
21+
22+
This _should_ make sure your **pytest** runs are picking up the latest changes to your Rust code.
23+
624
## Testing
725

826
We aim for comprehensive unit testing of this library.

0 commit comments

Comments
 (0)