Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions¶
Report bugs at https://github.com/dask/dask-image/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.
dask-image could always use more documentation, whether as part of the official dask-image docs, in docstrings, or even on the web in blog posts, articles, and such.
To build the documentation locally and preview your changes, first set up the conda environment for building the dask-image documentation:
$ conda env create -f environment_doc.yml $ conda activate dask_image_doc_env
This conda environment contains dask-image and its dependencies, sphinx, and the dask-sphinx-theme.
Next, build the documentation with sphinx:
$ cd dask-image/docs $ make html
Now you can preview the html documentation in your browser by opening the file: dask-image/docs/_build/html/index.html
The best way to send feedback is to file an issue at https://github.com/dask/dask-image/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Ready to contribute? Here’s how to set up dask-image for local development.
Fork the dask-image repo on GitHub.
Clone your fork locally:
$ git clone [email protected]:your_name_here/dask-image.git
Install your local copy into an environment. Assuming you have conda installed, this is how you set up your fork for local development (on Windows drop source). Replace “<some version>” with the Python version used for testing.:
$ conda create -n dask-image-env python="<some version>" $ source activate dask-image-env $ python setup.py develop
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions:
$ flake8 dask_image tests $ python setup.py test or py.test
To get flake8, just conda install it into your environment.
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include tests.
- If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
- The pull request should work for all supported Python versions. Check CIs and make sure that the tests pass for all supported Python versions and platforms.
To run a subset of tests:
$ py.test tests/test_dask_image.py