Contributing¶

We welcome contributions to the IVCAP Lambda SDK!

Getting Started¶

1. Fork and Clone¶

git clone https://github.com/YOUR_USERNAME/ivcap-ai-tool-sdk-python.git
cd ivcap-ai-tool-sdk-python

2. Set Up Development Environment¶

poetry install --with dev

3. Create a Branch¶

git checkout -b feature/my-feature

Development Workflow¶

Running Tests¶

poetry run pytest
poetry run pytest --cov=ivcap_lambda --cov-report=xml

Code Quality¶

# Format code
poetry run ruff format .

# Lint
poetry run ruff check . --fix

# Type checking
poetry run mypy ivcap_lambda

Building Documentation¶

cd docs
pip install -r requirements-docs.txt
mkdocs serve

Visit http://localhost:8000 to preview the docs.

Making Changes¶

Code Changes¶

Make your changes in a feature branch
Add tests for new functionality
Ensure all tests pass: poetry run pytest
Update documentation as needed

Documentation Changes¶

Edit files in docs/docs/
Test locally: cd docs && mkdocs serve
Check formatting and links
Submit pull request

Commit Messages¶

Use clear, descriptive commit messages:

✨ feat: add new feature
🐛 fix: resolve bug
📝 docs: update documentation
🧪 test: add unit tests
🔨 chore: refactor code

Pull Request Process¶

Update documentation
Add/update tests
Ensure CI passes
Create clear PR description
Link related issues

Code Style¶

We use:

Ruff — Linting and formatting
Mypy — Type checking
Pytest — Testing

Style Guide¶

# Docstrings follow Google style
def process(req: MyRequest, jobCtxt: JobContext) -> MyResult:
    """Process a request.

    Args:
        req: The request to process.
        jobCtxt: Job context for progress reporting.

    Returns:
        The processing result.

    Raises:
        ValueError: If validation fails.
    """
    pass

# Type hints required everywhere
def add(a: int, b: int) -> int:
    return a + b

Testing¶

Write tests for new features:

# tests/test_feature.py
import pytest
from ivcap_lambda import ivcap_lambda

def test_my_tool():
    from my_service import my_tool, MyRequest
    req = MyRequest(text="hello")
    result = my_tool(req)
    assert result.output == "HELLO"

Documentation Guidelines¶

Be clear — Write for developers new to the SDK
Include examples — Every concept should have a code example
Link between pages — Use relative links
Update mkdocs.yml — If adding new pages

Reporting Issues¶

Bug Reports¶

Include: - Minimal reproducible example - Expected vs actual behavior - Python version and ivcap-lambda version - Traceback (if applicable)

Feature Requests¶

Include: - Use case and motivation - Proposed API/syntax - Any alternatives considered

License¶

By contributing, you agree that your contributions will be licensed under the same BSD License as the project.

Thank you for contributing to IVCAP! 🚀