Skip to content

Latest commit

 

History

History
53 lines (36 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

53 lines (36 loc) · 1.76 KB
Raw

How to contribute

Overview: making a contribution

For more details, see the rest of this document.

  1. Fork GlacioHack/geoutils and clone your fork repository locally.
  2. Set up the development environment (section below).
  3. Create a branch for the new feature or bug fix.
  4. Make your changes, and add or modify related tests in tests/.
  5. Commit, making sure to run pre-commit separately if not installed as git hook.
  6. Push to your fork.
  7. Open a pull request from GitHub to discuss and eventually merge.

Development environment

GeoUtils currently supports only Python versions of 3.10 to 3.12, see environment.yml for detailed dependencies.

Setup

Clone the git repo and create a mamba environment (see how to install mamba in the mamba documentation):

git clone https://github.com/GlacioHack/geoutils.git
cd geoutils
mamba env create -f dev-environment.yml  # Add '-n custom_name' if you want.
mamba activate geoutils-dev  # Or any other name specified above

Tests

At least one test per feature (in the associated tests/test_*.py file) should be included in the PR, using pytest (see existing tests for examples).

To run the entire test suite, run pytest in the current directory:

pytest

Formatting and linting

Install and run pre-commit (see pre-commit documentation), which will use .pre-commit-config.yaml to verify spelling errors, import sorting, type checking, formatting and linting.

You can then run pre-commit manually:

pre-commit run --all-files

Optionally, pre-commit can be installed as a git hook to ensure checks have to pass before committing.

Rights

The license (see LICENSE) applies to all contributions.