Skip to content

Latest commit

 

History

History
58 lines (46 loc) · 2.06 KB

CONTRIBUTING.md

File metadata and controls

58 lines (46 loc) · 2.06 KB
Raw

Contributing

First read the overall project contributing guidelines. These are all included in the qiskit documentation:

https://github.com/Qiskit/qiskit/blob/main/CONTRIBUTING.md

Joining the Ecosystem

To join ecosystem you need to create submission issue and fill in all required details. That's it!

Installation and environment setup

  1. Create new environment
    conda create --name ecosystem python=3.9
  2. Activate the environment
    conda activate ecosystem
  3. install dependencies
pip install -r requirements.txt
pip install -r requirements-dev.txt

Running the tests

  1. To run tests against the stable version of qiskit
    python manager.py tests python_stable_tests <url_of_the github_repository> --python_version=py39 --run_name="stable"
  2. To run tests against the dev version of qiskit
    python manager.py tests python_dev_tests <url_of_the github_repository> --python_version=py39 --run_name="dev"
  3. To run tests within repository
    python manager.py tests python_standard_tests <url_of_the github_repository> --python_version=py39 --run_name="standard"

Performing style checks

  • Run for style checks tox -elint
  • Run for tests tox -epy39
  • Run coverage tox -ecoverage
  • Run black tox -eblack
  • To Fix the black violation black <PATH_FILE_YOU_WANT_TO_FIX>

Create a preview of the website

  1. Build the website: tox -ewebsite
  2. Go to the website/ folder in the root of your project and open up index.html in a browser

Guidance on git

Please follow this link if this is your first time contributing to open source and/or you would like some guidance on how to create and/or merge pull requests.

Dev contributions

Internals overview