Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (45 loc) · 1.09 KB

CONTRIBUTING.md

File metadata and controls

66 lines (45 loc) · 1.09 KB

Contributing to Koa

Thanks for your interest in contributing to Koa!

Development Setup

# Clone the repo
git clone https://github.com/withkoi/koa.git
cd koa

# Install in development mode
pip install -e ".[all]"

# Install dev dependencies
pip install -r requirements-dev.txt

Running Tests

pytest

Code Style

We use Black for formatting and Ruff for linting.

# Format code
black koa tests

# Lint
ruff check koa tests

# Type check
mypy koa

Pull Request Process

  1. Fork the repo and create your branch from main
  2. Add tests for any new functionality
  3. Ensure all tests pass
  4. Update documentation if needed
  5. Submit PR with a clear description

Commit Messages

Use clear, descriptive commit messages:

Add restaurant booking example
Fix validation error in InputField
Update getting-started documentation

Reporting Issues

  • Use the issue templates
  • Include steps to reproduce
  • Include Python version and OS

Questions?

Open an issue with the question label.