Skip to content

Latest commit

 

History

History
43 lines (31 loc) · 1.7 KB

File metadata and controls

43 lines (31 loc) · 1.7 KB

Contributing to OpenAdapt

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

  1. Fork the repository
  2. Clone your fork
  3. Install in development mode: pip install -e ".[dev]"
  4. Create a branch for your changes
  5. Make your changes and test locally
  6. Submit a pull request

Guidelines

  • Follow existing code style
  • Add tests for new functionality
  • Update documentation as needed
  • Keep PRs focused and small

Questions?