This repository has been archived by the owner on Aug 19, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 749
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md
- Loading branch information
1 parent
ead1324
commit 6ca83cb
Showing
1 changed file
with
19 additions
and
14 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 |
---|---|---|
@@ -1,29 +1,34 @@ | ||
# Contributing | ||
|
||
The documentation and benchmarking of Qiskit is contained in this repository. To contribute | ||
to them please read the | ||
[contributing guide](https://qiskit.org/documentation/contributing_to_qiskit.html): | ||
to this project or any of the elements of qiskit we recomend you start by reading the | ||
[contributing guide](https://qiskit.org/documentation/contributing_to_qiskit.html). | ||
|
||
## Contributor License Agreement | ||
|
||
We'd love to accept your code! Before we can, we have to get a few legal | ||
requirements sorted out. By having you sign a Contributor License Agreement (CLA), we | ||
ensure that the community is free to use your contributions. | ||
Before you can submit any code we need all contributors to sign a | ||
contributor license agreement. By signing a contributor license | ||
agreement (CLA) you're basically just attesting to the fact | ||
that you are the author of the contribution and that you're freely | ||
contributing it under the terms of the Apache-2.0 license. | ||
|
||
When you contribute to the Qiskit project with a new pull request, a bot will | ||
evaluate whether you have signed the CLA. If required, the bot will comment on | ||
the pull request, including a link to accept the agreement. The | ||
[individual CLA](https://qiskit.org/license/qiskit-cla.pdf) document is | ||
available for review as a PDF. | ||
When you contribute to the Qiskit project with a new pull request, | ||
a bot will evaluate whether you have signed the CLA. If required, the | ||
bot will comment on the pull request, including a link to accept the | ||
agreement. The [individual CLA](https://qiskit.org/license/qiskit-cla.pdf) | ||
document is available for review as a PDF. | ||
|
||
**Note**: | ||
> If your contribution is part of your employment or your contribution | ||
> is the property of your employer, then you will likely need to sign a | ||
> [corporate CLA](https://qiskit.org/license/qiskit-corporate-cla.pdf) too and | ||
> email it to us at <[email protected]>. | ||
If you work for a company that wants to allow you to contribute your work, | ||
then you'll need to sign a [corporate CLA](https://qiskit.org/license/qiskit-corporate-cla.pdf) | ||
and email it to us at [email protected]. | ||
|
||
## Documentation | ||
|
||
The documentation of Qiskit is in the ``docs`` directory. The | ||
documentation is generated using [Sphinx](http://www.sphinx-doc.org). In the main directory are the installing and general files and then in each subdirectory contains documentation for each element of Qiskit. Once a pull request is accepted the documentation will be auto-generated and rendered at [https://qiskit.org/documentation](https://qiskit.org/documentation). | ||
documentation is generated using [Sphinx](http://www.sphinx-doc.org). In the main directory are the installing and general files. Once a pull request is accepted the documentation will be auto-generated and rendered at [https://qiskit.org/documentation](https://qiskit.org/documentation). | ||
|
||
To edit the documentation, edit the rst files directly and then a html version can be made using: | ||
|
||
|