Contributing to Agency Swarm

​

Setting Up Your Development Environment

​

Prerequisites

• Python 3.12 or higher
• Pip
• Git

​

Setup

1. Clone the repository:
   git clone https://github.com/VRSEN/agency-swarm.git
   cd agency-swarm
   
2. Create and activate a virtual environment (recommended):
   python -m venv .venv
   source .venv/bin/activate  # On Windows use `.venv\Scripts\activate`
   
3. Install dependencies including development tools:
   pip install -e ".[dev]"
   
4. Install Pre-Commit Hooks:
   pip install pre-commit
   pre-commit install
   

​

Running Tests

pip install -e ".[dev]"

pytest

pytest --cov=agency_swarm tests/

​

Submitting Changes

git checkout -b feature/your-feature-name

git add .
git commit -m "Add [feature]: Description"

git push origin feature/your-feature-name

- Provide a concise title and description.
- Reference related issues.

​

Code Style and Linting

ruff check . --fix

pip install -e ".[dev]"