53 lines (38 loc) · 1.18 KB

Contributing to Plexus Agent

Thanks for your interest in contributing! Here's how to get started.

Development Setup

git clone https://github.com/plexus-oss/plexus-python.git
cd agent
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"

Running Tests

pytest
pytest --cov=plexus    # with coverage

Linting

ruff check .
ruff check --fix .     # auto-fix

Submitting Changes

Fork the repo and create a branch from main
Make your changes — add tests for new functionality
Run pytest and ruff check . and make sure both pass
Open a pull request with a clear description of what and why

Reporting Bugs

Open an issue at GitHub Issues with:

Python version and OS
Steps to reproduce
Expected vs actual behavior
Relevant logs or tracebacks

Code Style

Follow existing patterns in the codebase
Run ruff before committing
Add docstrings to public functions
Keep dependencies minimal — optional extras go in pyproject.toml

License

By contributing, you agree that your contributions will be licensed under the Apache License 2.0.