Skip to content

Latest commit

 

History

History
45 lines (26 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

45 lines (26 loc) · 1.1 KB
Raw

Contributing

We'd love to accept your contributions. Please follow the guidelines below.

Reporting bugs and requesting features

Users are encouraged to use GitHub issues for reporting issues and requesting features.

Code review

All submissions require review. To make a submission, open a GitHub pull request.

Running tests locally

The tests can be run locally using tox. To run the full test suite, execute tox -e ALL. Individual checks can also be run separately. For example:

Run unit tests for Python 3.9

tox -epy39

Run lint check

tox -elint

Run type check

tox -emypy

Run format check

tox -eblack

Building and checking the docs locally

To build the docs locally, run

tox -edocs

This will generate the documentation files and place them in the directory docs/_build/html. You can then view the files in your web browser, for example, by navigating to file:///QISKIT_RESEARCH_DIRECTORY/docs/_build/html/index.html. Please take this step when submitting a pull request to ensure that the changes you make to the documentation look correct.