Contributing

Development Setup

git clone https://github.com/vccimaging/AutoLens.git
cd AutoLens
pip install -r requirements.txt

Code Style

Format all code with Ruff before submitting:

ruff format .
ruff check .

Testing

Run the full test suite:

pytest tests/ -v

Run a single test file:

pytest tests/test_surfaces.py -v

Run with coverage:

pytest tests/ --cov=src --cov-report=term-missing

Pull Request Guidelines

1. Create a feature branch from main
2. Write tests for new functionality
3. Run ruff format . and pytest tests/ -v before pushing
4. Open a PR with a clear description of the changes

Building Documentation

pip install mkdocs-material mkdocstrings[python]
mkdocs serve  # preview at http://127.0.0.1:8000

Community

Join the DeepLens Slack workspace to connect with contributors. For inquiries, contact Xinge Yang (xinge.yang@kaust.edu.sa).