Contributing

Thank you for your interest in contributing to crop-row-detector and we welcome all pull request. To get set for development on crop-row-detector see the following.

Development uses pre-commit for code linting and formatting. To setup development with pre-commit follow these steps after cloning the repository:

Create a virtual environment with python:

python -m venv venv

Activate virtual environment:

source venv/bin/activate

Install crop-row-detector python package as editable with the development dependencies:

pip install -e .[dev]

Install pre-commit hooks

pre-commit install

You are now ready to contribute.

Running Test

Test is automatically run when making a commit, but can also be run with:

pytest

This will also generate a html coverage report in test_coverage.

Generating Documentation

To generate this documentation, in the docs folder run:

make html

This will generate html documentation in the docs/build/html folder.