Skip to content

Latest commit

 

History

History
63 lines (41 loc) · 3.67 KB

README.md

File metadata and controls

63 lines (41 loc) · 3.67 KB
Raw

QPowerAlgo

Bringing all Quantum Algorithms under one Roof ⚡

PRs Welcome

Overview

The goal of this project is to have in a single place all possible quantum algorithms and programs - in multiple available frameworks. We aim to achieve this collaboratively, so feel free to contribute in any way you want, just make sure to follow the contribution guidelines listed below.

In case you have any questions, feel free to tag one of the repo admins in your issue/PR (don't assign us to any issue!): Syed Farhan(@born-2learn), Ricardo Prins(@ricardoprins).

Contents

Our content is divided by quantum computing frameworks. Please create an issue if you wish to add code in a framework that we don't currently have here. Do not create folders in your submissions, unless specifically told to do so.

Also, we are accepting submissions to our Wiki section. Please let us know if you'd like to contribute to an article.

Contributing Guidelines

  • Issues will be assigned on a first come, first serve basis. You just have to comment on the issue, asking to be assigned, and it will be done if found fit.
  • Preferably, you cannot work on any issue that is not assigned to you.
  • In case you want to submit an improvement to an existing algorithm, we prefer that you create an issue, describing in details your improvement. This will help others to analyze your contribution. You can use the templates that we have provided :)
  • If you have anything else in mind, create an issue and please wait for it to be assigned to you. You can then start working on it and create a PR.
  • All PRs must be made from a Branch. Create a separate branch for every Issue you are working upon and once found fit, make a PR.
  • If you have no idea what are issues or PRs, please do refer to this link

Make sure your code works before submitting it :D

Where to upload the files

PLEASE READ THIS

  • Your files should be uploaded directly into the corresponding folder (e.g. if you wrote code for a Grover's Search with qiskit, it goes inside the Grover's Search folder within the qiskit folder and so on)
  • Edit the corresponding README.md file to add the link to your code in the corresponding section (GitHub Markdown Guide)
  • Under no circumstances create new folders within the language folders to upload your code unless specifically told to do so.
  • Also, be polite with the reviewers - they will be ALWAYS polite to you.

Our Contributors

CONTRIBUTORS.md

Code of Conduct

You can find our Code of Conduct here.

License

This project follows the MIT License.