From 4188641e70333acc5b9ee7d15ad808283eeb7d3d Mon Sep 17 00:00:00 2001 From: Raynel Sanchez Date: Thu, 20 Jul 2023 15:19:50 -0400 Subject: [PATCH] Add Contributing.md --- CONTRIBUTING.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9ee0af2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,29 @@ +# Contributing + +We follow the same guidelines as [Qiskit](https://qiskit.org/documentation/contributing_to_qiskit.html). All contributions must also follow these guidelines: + +## Bugs and feature requests: + +Please use Github Issues for reporting bugs found within this plugin. The same goes for feature requests. + +## Code Review + +All new coded feature proposals should be done via Pull Requests. All sumbissions will require review by one of the mantainers. + +## Code formatting: + +Please use [Black](https://pypi.org/project/black/) for code formatting. +Make sure to install the package by using: + +```sh +pip install black +``` +For automated code formatting with black: +```sh +black qiskit_qubit_reuse +``` + +For code formatting review, use: +```sh +black --check qiskit_qubit_reuse +``` \ No newline at end of file