Contributing

Contributions are welcome! Here's how to get started.

Development setup

# Clone the repository
git clone https://github.com/Cellular-Imaging-Amsterdam-UMC/omero-browser-qt.git
cd omero-browser-qt

# Install ZeroC ICE + omero-py (see Getting Started)
# Then install in editable mode with all extras
pip install -e ".[viewer,docs]"

Code style

• Follow PEP 8
• Use numpy-style docstrings for all public APIs
• Type annotations for function signatures

Building the documentation

# Live preview
mkdocs serve

# Production build
mkdocs build --strict

Submitting changes

1. Fork the repository
2. Create a feature branch (git checkout -b feature/my-change)
3. Make your changes
4. Update the Changelog under an Unreleased section
5. Open a pull request against main

Reporting issues

Please open an issue on GitHub with:

• Steps to reproduce
• Expected vs. actual behaviour
• Python version, OS, and omero-browser-qt version

License

By contributing you agree that your contributions will be licensed under the MIT License.