diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 98f180c0..5443bda9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,8 +28,8 @@ appreciate your help. A few things to keep in mind: - 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`. +- We require all code to be formatted with `pyink` (i.e., please run `uvx pyink .`). - 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. +- Please add (or update) documentation when adding new code. We use [Google Style docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html). - 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. diff --git a/README.md b/README.md index b3639f54..7482503c 100644 --- a/README.md +++ b/README.md @@ -143,6 +143,15 @@ _2025 update_: Something like this is being built across a few projects! The one As of writing, this project is [amid integrating](https://github.com/alxmrs/xarray-sql/pull/69) a rust-based DataFusion backend provided by arrow-zarr. +## Roadmap + +- [ ] [@RohanDisa](https://github.com/RohanDisa) DataFusion Interoperability via the Python Dataframe Protocol [#86](https://github.com/alxmrs/xarray-sql/issues/86). +- [ ] Translate a single Zarr to a collection of tables via DataFusion's catalog interface [#85](https://github.com/alxmrs/xarray-sql/issues/85). +- [ ] Distributed beyond a single node through the DataFusion integration with Ray Datasets [#68](https://github.com/alxmrs/xarray-sql/issues/68). +- [ ] Demo: calculate Sea Surface Temperature from 1940 - Present in SQL [#36](https://github.com/alxmrs/xarray-sql/issues/36). +- [ ] Provide an option to integrate DataFusion directly to Zarr via Rust [#4](https://github.com/alxmrs/xarray-sql/issues/4). +- [ ] (To be formally announced eventually): The 100 Trillion Row Challenge [#34](https://github.com/alxmrs/xarray-sql/issues/34). + ## Sponsors & Contributors I want to give a special thanks to the following folks and institutions: