Skip to content

Latest commit

 

History

History
81 lines (52 loc) · 2.41 KB

CONTRIBUTING.rst

File metadata and controls

81 lines (52 loc) · 2.41 KB

Contribute

Thank you for considering contributing to eodag!

Report issues

Issue tracker: https://github.com/CS-SI/opentelemetry-instrumentation-eodag/issues

Please check that a similar issue does not already exist and include the following information in your post:

  • Describe what you expected to happen.
  • If possible, include a minimal reproducible example to help us identify the issue. This also helps check that the issue is not with your own code.
  • Describe what actually happened. Include the full traceback if there was an exception.
  • List your Python and opentelemetry-instrumentation-eodag versions. If possible, check if this issue is already fixed in the latest releases or the latest code in the repository.

Submit patches

If you intend to contribute to opentelemetry-instrumentation-eodag source code:

git clone https://github.com/CS-SI/opentelemetry-instrumentation-eodag.git
cd opentelemetry-instrumentation-eodag
python -m pip install
pre-commit install

We use pre-commit to run a suite of linters, formatters and pre-commit hooks (black, isort, flake8) to ensure the code base is homogeneously formatted and easier to read. It's important that you install it, since we run the exact same hooks in the Continuous Integration.

To run the default test suite (which excludes end-to-end tests):

tox

To run the default test suite in parallel:

tox -p

To only run end-to-end tests:

tox -- tests/test_end_to_end.py

To run the entire tests (units, integration and end-to-end):

tox -- tests eodag

Note

  • Running the tox command will also build the docs. As the documentation includes some notebooks (for the tutorials), the build process will need pandoc to succeed. If the build process fails for you, please install pandoc and try again.
  • eodag is tested against python versions 3.8, 3.9, 3.10, 3.11 and 3.12. Ensure you have these versions installed before you run tox. You can use pyenv to manage many different versions of python