Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,24 @@
First off, thanks for contributing!
We appreciates you.

## Relationship to **stac-utils/rustac**

[stac-utils/rustac](https://github.com/stac-utils/rustac) is a Rust monorepo that provides _most_ of the functionality of this Python package.
It's pretty common that a bug in **rustac-py** is actually a bug in **rustac**.
Knowing which repository to work in can be a little tricky, so don't hesitate to reach out and ask.

## Python environment

It can be a little tricky to ensure that your Python environment is always up-to-date while developing a Rust+Python project.
We're still figuring out the _best_ way, but for now, try this:

```shell
uv sync
python -m maturin_import_hook site install
```

This _should_ make sure your **pytest** runs are picking up the latest changes to your Rust code.

## Testing

We aim for comprehensive unit testing of this library.
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ exclude = ["docs/examples/example_*.py"]
dev = [
"geopandas>=1.0.1",
"maturin>=1.7.4",
"maturin-import-hook>=0.2.0",
"mypy>=1.11.2",
"pyarrow>=19.0.1",
"pystac[validation]>=1.11.0",
Expand Down
24 changes: 24 additions & 0 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.