Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
107 lines (80 loc) · 3 KB

CONTRIBUTING.md

File metadata and controls

107 lines (80 loc) · 3 KB
Raw

Contributing to Agentomatic

Thank you for your interest in contributing! 🎉

Development Setup

git clone https://github.com/UnicoLab/agentomatic.git
cd agentomatic

# Install all dependencies + pre-commit hooks
make dev

Code Quality

We enforce strict code quality via pre-commit hooks and CI:

make lint          # Ruff linter
make format        # Auto-format
make typecheck     # Mypy type checking
make test          # Run all tests
make test-cov      # Tests with coverage
make check-all     # All checks at once

Commit Convention

We use Conventional Commits enforced by pre-commit:

feat: add new storage backend
fix: resolve thread ID collision
docs: update storage guide
chore: update dependencies
test: add middleware tests
ci: fix release workflow
refactor: simplify router factory
perf: optimize registry lookup

When creating commits via a HEREDOC, use /bin/cat (not bare cat). Many developer shells alias cat to bat, which injects ANSI colors and line numbers into the message and breaks Python Semantic Release / GitHub CI titles. Example:

git commit -m "$(/bin/cat <<'EOF'
ci: fix lint and typing

EOF
)"

A commit-msg pre-commit hook (scripts/strip_commit_msg_ansi.py) also strips ANSI/line-number garbage if it slips through — install hooks with pre-commit install --hook-type commit-msg.

Pull Request Process

  1. Fork the repository
  2. Branch from main (feat/my-feature or fix/my-fix)
  3. Write tests for any new functionality
  4. Ensure make check-all passes locally
  5. Submit a PR with a clear description

Architecture

src/agentomatic/
├── core/          # Platform, Registry, Router, Manifest
├── cli/           # CLI commands + templates
├── config/        # Settings and configuration
├── middleware/     # Auth, rate limit, metrics, logging
├── observability/  # Circuit breaker, metrics
├── providers/     # LLM and embedding providers
├── protocols/     # API decorators and response models
├── storage/       # BaseStore ABC + implementations
└── ui/            # Chainlit debug UI

Adding a New Storage Backend

  1. Subclass BaseStore from agentomatic.storage.base
  2. Implement all abstract methods
  3. Add tests in tests/test_storage_<name>.py
  4. Update docs in docs/guide/storage.md

Adding a New Template

  1. Add template functions in src/agentomatic/cli/templates.py
  2. Register in the TEMPLATES dict
  3. Add the template case in get_template_files()
  4. Add tests in tests/test_cli.py

Release Process

Releases are automated via python-semantic-release:

  1. Merge PR to main
  2. Semantic release analyzes commit messages
  3. If releasable commits found → bumps version, creates tag, publishes to PyPI
  4. Docs are auto-deployed via mike

License

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