Skip to content

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

  1. Fork and Clone the Repository:

    git clone https://github.com/YOUR_USERNAME/kiteML.git
    cd kiteML
    

  2. Create a Virtual Environment:

    python -m venv .venv
    source .venv/bin/activate  # On Windows: .venv\Scripts\activate
    

  3. Install Editable Package & Dev Extras:

    pip install -e ".[dev,all]"
    

  4. Run Unit Tests:

    pytest tests/
    


๐Ÿงช Code Quality & Style Guidelines

  • Linting & Formatting: We use ruff for linting and black for formatting.
    ruff check kiteml/
    black --check kiteml/
    
  • Type Checking: We use mypy for static type checking.
    mypy kiteml/
    
  • 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.