Contributing to Homodyne¶

Thank you for your interest in contributing to Homodyne.

This page provides a brief overview. For the full contribution guide, development environment setup, code style standards, testing requirements, and pull request guidelines, see the Developer Guide section.

Quick Links¶

Contributing to Homodyne — development environment, commit conventions, pull request checklist
Testing Guide — test organization, running the suite, coverage requirements
System Architecture — code layout, design decisions, ADRs

How to Contribute¶

Report a bug — open an issue on GitHub Issues.
Request a feature — start a GitHub Discussion first so the design can be agreed upon before implementation.
Submit a fix or feature — fork the repo, create a branch, and open a pull request against main.

All contributions must:

Pass make quality (Black, Ruff, MyPy).
Include tests covering the new or modified behaviour.
Update documentation if any public API changes.

Code of Conduct¶

Homodyne follows the Contributor Covenant Code of Conduct. All participants are expected to uphold these standards.