Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (37 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

56 lines (37 loc) · 1.4 KB

Contributing to AVP Python SDK

Dev Environment Setup

git clone https://github.com/VectorArc/avp-python.git
cd avp-python
pip install -e ".[dev]"

This installs torch, transformers, transport, server, and dev tools (pytest, ruff).

Running Tests

# All tests (requires torch + transformers)
pytest tests/

# Specific test file
pytest tests/test_codec.py

# vLLM integration tests (requires CUDA GPU + vLLM installed)
pytest tests/test_vllm_integration.py -m requires_vllm

vLLM integration tests are excluded by default. Run them explicitly with -m requires_vllm on a machine with a CUDA GPU.

Code Style

We use ruff for linting and formatting:

ruff check src/ tests/
ruff format src/ tests/

Configuration is in pyproject.toml: line length 99, target Python 3.10+.

Bug Reports

Open an Issue with:

  • What you expected vs what happened
  • Steps to reproduce
  • Python version, torch version, GPU (if applicable)

Feature Proposals

Open a GitHub Issue or submit a Pull Request. For protocol-level changes (binary format, handshake, modes), use the spec repo's RFC process.

Code of Conduct

  • Be respectful
  • Focus on ideas
  • Welcome newcomers
  • Assume good faith