Skip to content

Latest commit

 

History

History
158 lines (104 loc) · 9.77 KB

CONTRIBUTING.md

File metadata and controls

158 lines (104 loc) · 9.77 KB
Raw

Contributing to eo-learn

First of all, thank you for contributing to eo-learn. Any effort in contributing to the library is very much appreciated.

Here is how you can contribute:

All contributors agree to follow our Code of Conduct.

eo-learn is distributed under the MIT license. When contributing code to the library, you agree to its terms and conditions. If you would like to keep parts of your contribution private, you can contact us to discuss about the best solution.

For any question, feel free to contact us at eoresearch@sinergise.com or through our Forum.

Bug Reports

We strive to provide high-quality working code, but bugs happen nevertheless.

When reporting a bug, please check the issue tracker whether the bug was already reported. If not, open an issue with the bug label and report the following information:

  • Issue description
  • How to reproduce the issue
  • Expected outcome
  • Actual outcome
  • OS and package versions

This information helps us to reproduce, pinpoint, and fix the reported issue. If you are not sure whether the odd behaviour is a bug or a feature, best to open an issue and clarify.

Feature Requests

Existing feature requests can be found in the issues.

A new feature request can be created by opening a new issue with the enhancement label, and describing how the feature would benefit the eo-learn community. Providing an example use-case would help assessing the scope of the feature request.

Pull Requests

The GitHub Pull Request (PR) mechanism is the best option to contribute code to the library. Users can fork the repository, make their contribution to their local fork and create a PR to add those changes to the codebase. GitHub provides excellent tutorials on how the fork and pull mechanism work, and on how to best create a PR.

Existing PRs can be found here. Before creating new PRs, you should check whether someone else has contributed a similar feature, and if so, you can add your input to the existing code review.

The following guidelines should be observed when creating a PR.

General guidelines

  • Where applicable, create your contribution in a new branch of your fork based on the develop branch, as the master branch is aligned to the released package on PyPI. Upon completion of the code review, the branch will be merged into develop and, at the next package release, into master.

  • Document your PR to help maintainers understand and review your contribution. The PR should include:

    • Description of contribution;
    • Required testing;
    • Link to issue/feature request.

  • Do not forget to add yourself as a contributor to the CREDITS.md file, found in the root of the repository.

  • When submitting the PR, a member of the development team has to approve the CI run (notify us if we forget). If it returns any errors, try to fix the issues causing failure. For information on how to run the tests locally, see Section on Running formatters, linters, and tests.

  • Your contribution should include unit tests, to test correct behaviour of the new feature and to lower the maintenance effort. This applies to both bug fixes and new features.

  • Try to keep contributions small, as this speeds up the reviewing process. In the case of large contributions, e.g. a new complex EOTask, it's best to contact us first to review the scope of the contribution.

  • Keep API compatibility in mind, in particular when contributing a new EOTask. Check the Section below for more information on how to contribute an EOTask.

  • New features or tasks should be appropriately commented using Sphinx style docstrings. The documentation uses the PEP-8 formatting guidelines.

Development environment

  • Get the latest development version by creating a fork and clone the repo:
git clone git@github.com:<username>/eo-learn.git

  • Make sure that you have a suitable version of Python installed. Check the GitHub page badges on which versions are currently supported.

  • All eo-learn packages can be installed at once using the script python install_all.py -e. To install each package separately, run pip install -e <package_folder>. We strongly recommend initializing a virtual environment before installing the required packages. Example on how to create an environment an install all subpackages and development requirements:

cd eo-learn
# The following creates the virtual environment in the ".env" folder.
virtualenv --python python3 .env
source .env/bin/activate

# The following installs all eo-learn subpackages and development packages
# using PyPI in the activated virtualenv environment.
python install_all.py -e
pip install -r requirements-dev.txt -r requirements-docs.txt

Note: to reduce later merge conflicts, always pull the latest version of the develop branch from the upstream eo-learn repository (located here) to your fork before starting the work on your PR.

Contribute an EOTask

EOTasks are currently grouped into subpackages by scope, e.g. core, IO, masks, and so on. A list of implemented tasks can be found in the documentation. The following code snippet shows how to create your own EOTask:

class FooTask(EOTask):
    def __init__(self, foo_params):
        self.foo_params = foo_params

    def execute(self, eopatch, *, execution_kwargs):
        # do what foo does on input eopatch and return it
        return eopatch

When creating a new task, bear in mind the following:

  • Tasks should be useful for multiple use-cases or solve a common problem, i.e., other users should benefit from it.
  • In cases of large monolithic tasks you might want to try and split them into multiple ones, where each does just part of the computation. For instance a task for detecting foliage from S2 imagery could perhaps be split into a task for calculating NDVI and a separate task for thresholding the NDVI values. In many cases you'll find that some of these smaller tasks already exist in eo-learn.
  • When multiple tasks share a large part of the implementation, consider extracting parts of it into functions or use inheritance to reduce boilerplate.
  • Only hard-code parameters that shouldn't be adjusted by the users. Hard-coding things like feature names should be avoided.
  • Use feature-parsers in order to support a wider range of possible input (and perhaps validate inputs). You can find them in eolearn.core.utils.parsing, or use EOTask.parse_features as a shortcut.
  • If in doubt on whether a task is general enough to be of interest to the community, or you are not sure to which sub-package to contribute your task to, feel free to open up a feature request.

Running formatters, linters, and tests

This section assumes you have installed all packages in requirements-dev.txt.

Most of the automated code-checking is packaged into pre-commit hooks. You can activate them by running pre-commit install. If you wish to check all code you can do so by running pre-commit run --all-files. This takes care of:

  • auto-formatting the code using black, isort, and autoflake
  • checking the code with ruff
  • checking and formatting any Jupyter notebooks with nbqa
  • various other helpful things (correcting line-endings etc.)

The code is also checked using pylint and mypy. Because of the project structure invoking these two checkers is a bit trickier and has to be performed on each module separately. If your contribution is in core, you could do the following:

# to check the 'core' subpackage
mypy core/eolearn/core
pylint core/eolearn/core

You can also use the utilities provided in the MAKEFILE to check the entire package with make pylint and make mypy. Due to the size of the codebase this might take a while.

The last bit to check are the unit tests. We again reiterate that you should include unit-tests of your contributions. If you are not well versed with unit-testing you can ask us for help in the pull-request or by issuing a ticket instead. To run the tests simply use the command pytest from the main folder. Since eolearn.io also test integration with SentinelHub you can either skip them with pylint -m "not sh_integration" or see the examples/README.md for how to setup you SentinelHub account and local config for testing.

Looking forward to include your contributions into eo-learn.