-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
29 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
``` |