Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (51 loc) · 3.18 KB

CONTRIBUTING.md

File metadata and controls

64 lines (51 loc) · 3.18 KB
Raw

Contributing Guide

Where to start?

Please check out the issues tab. Let's have a discussion over there before proceeding with any changes. Great minds think alike -- someone may have already created an issue related to your inquiry. If there's a bug, please let us know.

If you're totally new to open source development, I recommend reading Xarray's contributing guide.

Developer setup

We use uv to manage the project. This project also contains a Rust extension (built with maturin), so a Rust toolchain is required.

  1. Install Rust: https://rustup.rs/

  2. Install uv: https://docs.astral.sh/uv/getting-started/installation/

  3. Clone the repository (bonus: via SSH) and cd xarray-sql (the project root).

  4. Install Python dev dependencies (without building the Rust extension yet):

    uv sync --dev --no-install-package xarray-sql

  5. Build and install the Rust extension into the virtual environment:

    uv run --no-project maturin develop --uv

    This compiles the native code and links it so that import xarray_sql works. Re-run this step whenever you modify any Rust source files under src/.

  6. Run the test suite to verify your setup:

    uv run --no-project pytest -v . -m "not integration"

  7. Install pre-commit hooks: uvx pre-commit install

    This will automatically run code formatting and type checking before each commit. You can also run the hooks manually with: uvx pre-commit run --all-files

  8. Build and serve docs locally: uvx zensical serve

Before submitting a pull request...

Thanks so much for your contribution! For a volunteer led project, we so appreciate your help. A few things to keep in mind:

  • Please be nice. We assume good intent from you, and we ask you to do the same for us.
  • Development in this project will be slow if not sporadic. Reviews will come as time allows.
  • Every contribution, big or small, matters and deserves credit.

Here are a few requests for your development process:

  • We require all code to be formatted with pyink and type-checked with mypy. These checks run automatically via pre-commit hooks (see Developer setup above). If you need to run them manually:
    • Formatting: uvx pre-commit run pyink --all-files or uvx pyink .
    • Type checking: uvx pre-commit run mypy --all-files or uvx mypy xarray_sql/
  • Please include unit tests, if possible, and performance tests when you touch the core functionality (see perf_tests/).
  • It's polite to do a self review before asking for one from a maintainer. Don't stress if you forget; we all do sometimes.
  • Please add (or update) documentation when adding new code. We use Google Style docstrings.
  • We are thrilled to get documentation-only PRs -- especially spelling and typo fixes (I am a bad speller). If writing tutorials excites you, it would be to everyone's benefit.