Contributing

This package has been first created and published by Adrien Barbaresi. It has then benefited from extensive refactoring by Juanjo Diaz (especially the new classes). See the full list of contributors to the repository.

Feel free to contribute, notably by filing issues for feedback, bug reports, or links to further lemmatization lists, rules and tests.

Contributions by pull requests ought to follow the following conventions: code style with black, type hinting with mypy, included tests with pytest.

Development setup

Install the development dependencies (tests, linters and type checker) from the project's optional-dependency groups:

pip install ".[dev]"

Before opening a pull request, please make sure it passes all the quality checks that CI runs:

# Code style
black --check --diff simplemma training tests
# Linting
flake8 simplemma training tests
# Type checking
mypy -p simplemma -p training -p tests
# Tests
pytest --cov=./ --cov-report=xml

Contributing to documentation

Install the documentation dependencies and build (or preview) the site locally:

pip install ".[docs]"
mkdocs build --strict   # fails on warnings; use `mkdocs serve` for a live preview