Contributing

Contributing

Contributions to Vayu are welcome!

Development Setup

git clone https://github.com/CodeWithBehnam/vayu.git
cd vayu

# Using uv (recommended)
uv pip install -e ".[dev]"

# Using pip
pip install -e ".[dev]"

Making Changes

1. Fork the repo and create a branch from master
2. Make your changes
3. Run tests: pytest
4. Format code: black . and isort .
5. Submit a pull request

Running Tests

pytest

Tests focus on security (model loading path validation) and core functionality.

Code Style

• Formatter: Black (line length 88)
• Import sorting: isort (Black profile)
• Type checking: mypy (Python 3.10 target)

Reporting Bugs

Open an issue using the Bug Report template. Include:

• macOS version
• Apple Silicon chip (M1/M2/M3/M4)
• Python version
• Vayu version (uv pip show vayu-whisper or pip show vayu-whisper)
• Minimal code example to reproduce the problem

Feature Requests

Open an issue using the Feature Request template. Describe:

• The problem you're solving
• Your proposed API or CLI interface
• Any relevant context or alternatives you've considered

Project Structure

See the Architecture page for a detailed breakdown of the codebase.