Thanks for your interest in contributing to mantis!
Please read the README for an overview of the project, and how you can install and use the package.
Any change made to the main branch or release maintenance branches
need to be proposed in a pull request (PR).
Follow these instructions to fork the repository.
- Install the package in development mode:
pip install -e ".[dev]"
- Install pre-commit hooks:
pre-commit install
The pre-commit hooks automatically run style checks (e.g. flake8, black, isort) when staged changes are committed. Resolve any violations before committing your changes. You can manually run the pre-commit hooks at any time using the make pre-commit command.
A makefile is included to help with a few basic development commands. Currently, the following commands are available:
make setup-develop # setup the package in development mode
make uninstall # uninstall the package
make check-format # run black and isort format check
make format # run black and isort formatting
make lint # run flark8 linting
make pre-commit # run pre-commit hooks on all files
make test # run pytest