Contributions are welcome.
make install
make pre-commit-installRun all checks:
make allIndividual checks:
make lint
make format
make type
make test
make cov
make build
make checkThis project uses:
rufffor linting and formatting;mypyfor strict type checking;pytestfor tests.
Before opening a pull request, please make sure:
make allpasses.
If you change behavior, please add or update tests in:
tests/
Aim to keep coverage high.
- Tests pass.
- Linting passes.
- Type checking passes.
- Documentation is updated if needed.
-
CHANGELOG.mdis updated if the change is user-facing.
Please use clear commit messages.
Examples:
Add support for keyword-only parameter validation
Fix false positive for classmethod signatures
Update documentation for check_return_type