Contributing to OpenAdapt
January 17, 2026 ยท View on GitHub
Thank you for your interest in contributing to OpenAdapt!
Architecture
OpenAdapt uses a modular meta-package architecture. The main openadapt package coordinates these sub-packages:
| Package | Purpose | Repository |
|---|---|---|
| openadapt-capture | GUI recording | openadapt-capture |
| openadapt-ml | ML training/inference | openadapt-ml |
| openadapt-evals | Benchmark evaluation | openadapt-evals |
| openadapt-viewer | HTML visualization | openadapt-viewer |
| openadapt-grounding | UI element localization | openadapt-grounding |
| openadapt-retrieval | Multimodal retrieval | openadapt-retrieval |
| openadapt-privacy | PII/PHI scrubbing | openadapt-privacy |
Where to Contribute
- This repository: Meta-package, CLI, documentation, CI/CD
- Sub-packages: Open issues in the relevant repository above
Getting Started
- Fork the repository
- Clone your fork
- Install in development mode:
pip install -e ".[dev]" - Create a branch for your changes
- Make your changes and test locally
- Submit a pull request
Guidelines
- Follow existing code style
- Add tests for new functionality
- Update documentation as needed
- Keep PRs focused and small