Skip to main content

Contributing to OMEGA

Thanks for your interest in contributing to OMEGA!

Development Setup

git clone https://github.com/omega-memory/omega-memory.git
cd omega-memory
python3.12 -m venv .venv
source .venv/bin/activate
pip install -e ".[server,dev]"
omega setup

Running Tests

pytest tests/                          # All tests
pytest tests/ --cov=omega              # With coverage
pytest tests/test_bridge.py -v         # Single file
ruff check src/ tests/                 # Lint

Code Style

  • Linter: ruff (config in pyproject.toml)
  • Line length: 120 characters
  • Python: 3.11+
  • Commits: Conventional Commits (feat:, fix:, docs:, test:, chore:)

Pull Request Process

  1. Fork the repo and create a branch from main
  2. Make your changes with tests
  3. Ensure pytest and ruff check pass
  4. Submit a PR with a clear description of the change

Architecture

  • src/omega/bridge.py — Public API (start here for new features)
  • src/omega/sqlite_store.py — Storage layer (SQLite + sqlite-vec + FTS5)
  • src/omega/server/handlers.py — MCP tool handlers
  • src/omega/server/hook_server.py — Daemon hook handlers
  • src/omega/coordination.py — Multi-agent coordination
  • src/omega/server/coord_handlers.py — Coordination MCP handlers
  • tests/ — 1538+ tests across 39 files

Reporting Issues

Use GitHub Issues. For security vulnerabilities, see the security policy.

License

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