Contributing to KiteML
Thank you for your interest in contributing to KiteML! We welcome bug reports, feature requests, documentation improvements, and pull requests from developers of all skill levels.
๐ Quick Setup for Developers
-
Fork and Clone the Repository:
-
Create a Virtual Environment:
-
Install Editable Package & Dev Extras:
-
Run Unit Tests:
๐งช Code Quality & Style Guidelines
- Linting & Formatting: We use
rufffor linting andblackfor formatting. - Type Checking: We use
mypyfor static type checking. - Docstring Style: Write all docstrings in Google Python Style.
๐ Pull Request Checklist
Before submitting your PR, ensure:
- [x] All pytest tests pass (pytest tests/).
- [x] Code passes linting (ruff check) and formatting (black).
- [x] New features or bug fixes include corresponding unit tests in tests/.
- [x] Documentation is updated if public APIs or CLI commands changed.