Skip to content

Latest commit

 

History

History
56 lines (36 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

56 lines (36 loc) · 1.81 KB
Raw

Contributing

We appreciate all kinds of help, so thank you!

Contributing to PurpleCaffeine

Specific details for contributing to this project are outlined below.

Reporting Bugs and Requesting Features

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

Ask/Answer Questions and Discuss Quantum Prototype Template

Users are encouraged to use GitHub Discussions for engaging with researchers, developers, and other users regarding this project and the provided examples.

Tox commands

In order to run any tox command, you need to declare in which part of the project you want to run tox. To do so, set up a variable first :

export FOLDER="client"
#export FOLDER="api_server"

Unit tests

In order to fully run the unit tests, you need to setup the API (refer to the README.md of api_server folder).

Project Code Style

Code in this repository should conform to PEP8 standards. Style/lint checks are run to validate this. Line length must be limited to no more than 88 characters.

Pull Request Checklist

When submitting a pull request and you feel it is ready for review, please ensure that:

  1. The code follows the code style of this project and successfully passes the unit tests. This project uses Pylint and PEP8 style guidelines.

    You can run

    tox -elint

    from the root of the repository clone for lint conformance checks.

Tox commands available

  • 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>