25 lines (19 loc) · 860 Bytes

Contributing

Thank you for considering contributing to this project!

Code Style

Use black for formatting.
Use flake8 and isort for linting and import sorting.
Type annotations are encouraged and checked with mypy.

Pre-commit Hooks

Run pre-commit install after cloning to enable automatic code checks.
Run pre-commit run --all-files before pushing.

Pull Requests

Fork the repo and create your branch from main.
Ensure all tests pass (pytest).
Add/Update tests for new features or bugfixes.
Keep PRs focused and well-described.

Tests

Place tests in the tests/ directory.
Use pytest for writing tests.

Questions

Open an issue or discussion for help or suggestions.