Skip to content

Commit 7414128

Browse files
authored
Added a roadmap to the readme. (#90)
Also, added a few useful notes to the contrib guide.
1 parent 2f346bf commit 7414128

2 files changed

Lines changed: 11 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ appreciate your help. A few things to keep in mind:
2828
- Every contribution, big or small, matters and deserves credit.
2929

3030
Here are a few requests for your development process:
31-
- We require all code to be formatted with `pyink`.
31+
- We require all code to be formatted with `pyink` (i.e., please run `uvx pyink .`).
3232
- Please include unit tests, if possible, and performance tests when you touch the core functionality (see `perf_tests/`).
3333
- 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.
34-
- Please add (or update) documentation when adding new code. We use Google Style docstrings.
34+
- Please add (or update) documentation when adding new code. We use [Google Style docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html).
3535
- 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.

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,15 @@ _2025 update_: Something like this is being built across a few projects! The one
143143
As of writing, this project is [amid integrating](https://github.com/alxmrs/xarray-sql/pull/69) a
144144
rust-based DataFusion backend provided by arrow-zarr.
145145

146+
## Roadmap
147+
148+
- [ ] [@RohanDisa](https://github.com/RohanDisa) DataFusion Interoperability via the Python Dataframe Protocol [#86](https://github.com/alxmrs/xarray-sql/issues/86).
149+
- [ ] Translate a single Zarr to a collection of tables via DataFusion's catalog interface [#85](https://github.com/alxmrs/xarray-sql/issues/85).
150+
- [ ] Distributed beyond a single node through the DataFusion integration with Ray Datasets [#68](https://github.com/alxmrs/xarray-sql/issues/68).
151+
- [ ] Demo: calculate Sea Surface Temperature from 1940 - Present in SQL [#36](https://github.com/alxmrs/xarray-sql/issues/36).
152+
- [ ] Provide an option to integrate DataFusion directly to Zarr via Rust [#4](https://github.com/alxmrs/xarray-sql/issues/4).
153+
- [ ] (To be formally announced eventually): The 100 Trillion Row Challenge [#34](https://github.com/alxmrs/xarray-sql/issues/34).
154+
146155
## Sponsors & Contributors
147156

148157
I want to give a special thanks to the following folks and institutions:

0 commit comments

Comments
 (0)