01. How to Contribute
OpenEyes is an Apache 2.0 open-source framework. We welcome pull requests for bug fixes, new model integrations, and performance optimizations (especially TensorRT).
git
# Fork and clone
git clone https://github.com/mandarwagh9/openeyes
cd openeyes
# Create feature branch
git checkout -b feature/model-optimization
# Test your changes before committing
pytest tests/ -v
pytest tests/test_camera.py -x
02. Code Standards
We enforce strict standards to maintain pipeline performance.
- Python 3.10+ required. All functions must have type hints.
- Zero-copy data. Pass pointers to GPU buffers instead of pulling to CPU whenever possible.
- Docstrings. Use Google-style docstrings for all core modules.
- Imports. Sort with isort and format with black (line length 120).
- Logging. Do not use standard print(). Use from src.utils.logger import get_logger.