Skip to content

Latest commit

 

History

History
58 lines (39 loc) · 1.03 KB

File metadata and controls

58 lines (39 loc) · 1.03 KB

Contributing to openapi-batch

Thank you for your interest in contributing.

This project prioritizes:

  • simplicity
  • predictable behavior
  • clear developer experience

Please keep changes focused and easy to review.


Development setup

git clone https://github.com/<your-org>/openapi-batch
cd openapi-batch
pip install -e .[dev]

Run tests:

pytest

Integration tests (opt-in, require API keys):

export OPENAI_API_KEY=...
export GEMINI_API_KEY=...
pytest -m integration

Guidelines

  • Prefer small, incremental changes
  • Avoid adding abstractions unless they remove real complexity
  • Do not introduce new dependencies lightly
  • Keep provider-specific logic isolated under providers/
  • All public APIs should be documented or obvious by usage

Pull requests

  • Describe why the change is needed
  • Include tests when behavior changes
  • Keep formatting consistent with existing code

Design questions

If unsure about an approach, open an issue before starting a large change.