Development of the qiskit-addon-obp package takes place on GitHub.
The Contributing to Qiskit guide may serve as a
useful starting point, as this package builds on Qiskit.
This package is written in Python and uses tox as a testing framework. A description of the available
tox test environments is located at test/README.md. These environments are used in the
CI workflows, which are described at .github/workflows/README.md.
Project configuration, including information about dependencies, is stored in pyproject.toml.
We use Sphinx for documentation and reno for release notes. We use Google style docstrings, except we omit the type of each argument, as type information is redundant with Python type hints.
We require 100% coverage in all new code.
In rare cases where it is not possible to test a code block, we mark it with # pragma: no cover so that
the coverage tests will pass.