DOC: Proposed updates to contributor guide. #2513
Conversation
| @@ -92,12 +92,11 @@ the following:: | |||
| $ mkdir -p ~/pyenv/zarr-dev | |||
| $ python -m venv ~/pyenv/zarr-dev | |||
| $ source ~/pyenv/zarr-dev/bin/activate | |||
| $ pip install -r requirements_dev_minimal.txt -r requirements_dev_numpy.txt | |||
| $ pip install -e .[docs] | |||
| $ pip install -e .[test,docs] | |||
There was a problem hiding this comment.
There don't appear to be requirements files anymore, so I assume that the optional-dependencies is the intended replacement - not sure how these intersect requirements_dev_minimal and requirements_dev_numpy but these appear to be the minimal ones to run the tests and build the docs!
There was a problem hiding this comment.
We are using hatch now to manage our development environments. I think we should replace the virtual env directions with instructions on how to use hatch.
|
|
||
| To verify that your development environment is working, you can run the unit tests:: | ||
|
|
||
| $ python -m pytest -v zarr | ||
| $ python -m pytest -v tests |
There was a problem hiding this comment.
It looks like there's been a src/tests split since this was written, so the original recommendation no longer applies. This should work and be portable, but feel free to replace with whichever incantation is preferred!
There was a problem hiding this comment.
I think the standard invocation is hatch env run run (perhaps we should change this to hatch env run tests?)
| @@ -149,7 +148,7 @@ and invoke:: | |||
| Some tests require optional dependencies to be installed, otherwise | |||
| the tests will be skipped. To install all optional dependencies, run:: | |||
|
|
|||
| $ pip install -r requirements_dev_optional.txt | |||
| $ pip install pytest-doctestplus | |||
There was a problem hiding this comment.
I didn't see pytest-doctestplus listed anywhere in the optional dependencies, and I don't know what else may have been in requirements_dev_optional.
There was a problem hiding this comment.
I'd be pro putting this in the test dependencies section, and then not having any optional dependencies for testing? That way it's a bit simpler.
|
I just activated the check. So, go ahead and click auto-merge when you're ready. |
|
I've squashed and auto-merged, so 🤞 |
I just took a walk through the contributor guide and noticed it appears to be out-of-sync with the current structure of the repo.
I went ahead and made some minor tweaks to get things working again, but someone with knowledge of any recent restructuring should give the whole document a once-over!