Contributing

Issues, pull requests and review expectations.

Quatm is developed with a small core team and contributions from laboratories. We welcome bug reports, documentation fixes, driver additions and well-scoped improvements.

Before opening an issue

Search existing issues and pull requests.
Include the commit or version, operating system, Python version and the affected application.
For hardware issues, include the driver, instrument model, connection type and relevant logs.
Do not paste licence keys, tokens or personal data.

Pull requests

Keep changes focused; do not mix unrelated refactors with a fix.
Follow the repository conventions in docs/CONVENTIONS.md and AGENTS.md.
Add or update tests for behaviour changes.
Run bash scripts/check.sh and report the exit code.
Update documentation and translations when user-facing strings change.

Review

The review checks correctness, experiment semantics, resource lifecycle, licensing boundaries and test coverage. Changes that affect timing or units require an explicit rationale. Large architectural changes should start with an ADR under docs/adr/.

Security

Do not report security vulnerabilities in public issues. Contact security@quatm.com; see the security policy.