Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
74 lines (55 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

74 lines (55 loc) · 1.52 KB
Raw

Contributing to Reflexia Python SDK

Thank you for your interest in contributing to the Reflexia Python SDK!

Development Setup

  1. Clone the repository:
git clone https://github.com/reflexia/reflexia-python-sdk.git
cd reflexia-python-sdk
  1. Create a virtual environment:
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
  1. Install dependencies:
pip install -e ".[dev]"

Code Style

We use:

  • Black for code formatting (line length: 100)
  • Ruff for linting
  • mypy for type checking

Before committing, run:

black reflexia/ examples/
ruff check reflexia/ examples/
mypy reflexia/

Testing

Run tests with:

pytest

With coverage:

pytest --cov=reflexia --cov-report=html

Pull Request Process

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Ensure all tests pass and code is formatted
  5. Commit your changes (git commit -m 'Add amazing feature')
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

What to Contribute

We welcome contributions for:

  • Bug fixes
  • Documentation improvements
  • Additional examples
  • Type hints improvements
  • Performance optimizations

Note: This SDK is a convenience wrapper around HTTP requests. We don't accept contributions that add business logic or change the API contract—those belong in the backend API.

Questions?

Open an issue or contact us at support@reflexia.dev