Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

45 lines (30 loc) · 1.53 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.

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.

All the Javascript code must confirm to Standard Js styling

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 Black style guidelines.

    You can run

    black .

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

  2. To Check the Code style of Javascript, test usign ESLint standard you can run

    npx eslint .

Tox commands available

  • To Fix the black violation black <PATH_FILE_YOU_WANT_TO_FIX>
  • To Fix the some of the ESLint violations npx eslint . --fix <PATH_FILE_YOU_WANT_TO_FIX>