First read the overall project contributing guidelines. These are all included in the qiskit documentation:
https://github.com/Qiskit/qiskit/blob/main/CONTRIBUTING.md
All contributions are welcome.
If you've noticed a bug or have a feature request, we encourage to open an issue in this repo's issues tracker, whether or not you plan to address it yourself.
If you intend to contribute code, please still start the contribution process by opening a new issue or making a comment on an existing issue briefly explaining what you intend to address and how. This helps us understand your intent/approach and provide support and commentary before you take the time to actually write code, and ensures multiple people aren't accidentally working on the same thing.
When you're ready to make a pull request, please make sure the following is true:
- The code matches the project's code style
- The documentation, including any docstrings for changed methods, has been updated
- If appropriate for your change, that new tests have been added to address any new functionality, or that existing tests have been updated as appropriate
- All of the tests (new and old) still pass!
- You have added notes in the pull request that explains what has changed and links to the relevant issues in the issues tracker
This package uses the pytest test runner.
To use pytest directly, just run:
pytest [pytest-args]Alternatively, you may also use setuptools integration by running tests through setup.py, e.g.:
python setup.py test --addopts="[pytest-args]"