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.
- (Recommended) Create a project-specific python environment. (mini)Conda or Mamba is preferred.
- Clone the repository (bonus: via SSH)
and
cd xarray_sql(the project root). - Install dev dependencies via:
pip install -e ".[dev]
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. - 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.