Skip to content

Contributing

This section documents the standard development workflow and quality bar for SilentSwarm changes.

Current Topics

  • Environment setup uses Python 3.11+ and editable installs from the repository root.
  • Docstring style for public modules, classes, and functions.
  • Code style expectations: keep changes focused, prefer existing package patterns, and avoid generated artifact churn.
  • Testing expectations: add or update unit tests for new behavior; add integration coverage when behavior crosses leader/fellow/CLI boundaries.
  • Documentation expectations: update the closest README or docs page whenever user-facing behavior, commands, config, or APIs change.

Setup

python3 -m venv .venv
source .venv/bin/activate
pip install -U pip
pip install -e ".[dev,docs]"

Validation

python -m pytest tests/unit/ -q --tb=short
mkdocs build --strict
  • tests/
  • src/
  • docs/
  • exp/