paleolimbot commented on code in PR #184: URL: https://github.com/apache/sedona-db/pull/184#discussion_r2404814861
########## docs/contributors-guide.md: ########## @@ -155,6 +155,12 @@ native component with: maturin develop ``` +If you don't yet have maturin installed, you can install it using pip + +```shell +pip install maturin +``` + Review Comment: Typically build dependencies are not included as test dependencies (e.g., projects using Cython do not typically add Cython to their pyproject.toml's test dependencies that I'm aware of). Because maturin is a "build backend", pip installs it automatically if a build is required. If a build isn't required (e.g., somebody downloaded a nightly wheel), there's no need to have it installed. All this to say that I think your documentation change is good here! ########## docs/contributors-guide.md: ########## @@ -175,6 +181,39 @@ Rust, C, or C++ code can be debugged using the [CodeLLDB](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb) *Attach to Process...* command from the command palette in VSCode. +## Testing + +### Running Rust tests + +We use cargo to run the Rust tests. + +```shell +cargo test +``` + +### Running Python tests + +A large number of the Python tests rely on a running PostGIS instance. You can spin one up by using the providied PostGIS docker compose file. + +```shell +docker compose up -d +``` + +You can later shut it down with +```shell Review Comment: ```suggestion You can later shut it down with ```shell ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
