Skip to content
This repository was archived by the owner on Aug 21, 2023. It is now read-only.

Commit 2d8d17c

Browse files
committed
Updating readme and contribute
1 parent bb891f0 commit 2d8d17c

File tree

2 files changed

+28
-15
lines changed

2 files changed

+28
-15
lines changed

.github/CONTRIBUTING.rst

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
Contributing
22
===============
3-
If you would like to contribute to the tutorials, there are a number of ways to
3+
4+
If you would like to contribute to the Qiskit-tutorials, there are a number of ways to
45
get involved:
56

67
* **Issues**: Issues can be reported with GitHub `issue
@@ -13,4 +14,21 @@ get involved:
1314
from the `master` branch and create a
1415
`pull requests <https://help.github.com/articles/about-pull-requests>`_ for your change.
1516
Note that new notebooks should be placed in the relevant part of the
16-
`Community <community/>`_ section.
17+
`Community <./community/>`_ section.
18+
19+
Contributor License Agreement
20+
-----------------------------
21+
22+
We'd love to accept your code! Before we can, we have to get a few legal
23+
requirements sorted out. By signing a contributor license agreement (CLA), we
24+
ensure that the community is free to use your contributions.
25+
26+
When you contribute to the Qiskit Terra project with a new pull request, a bot will
27+
evaluate whether you have signed the CLA. If required, the bot will comment on
28+
the pull request, including a link to accept the agreement. The
29+
`individual CLA <https://qiskit.org/license/qiskit-cla.pdf>`_ document is
30+
available for review as a PDF.
31+
32+
NOTE: If you work for a company that wants to allow you to contribute your work,
33+
then you'll need to sign a `corporate CLA <https://qiskit.org/license/qiskit-corporate-cla.pdf>`_
34+
and email it to us at [email protected].

README.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,25 @@
11
# Qiskit Tutorials
2-
[![License](https://img.shields.io/github/license/Qiskit/qiskit-tutorials.svg?style=popout-square)](https://opensource.org/licenses/Apache-2.0)
3-
[![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/QISKit/qiskit-tutorial/master?filepath=index.ipynb)
42

3+
[![License](https://img.shields.io/github/license/Qiskit/qiskit-tutorials.svg?style=popout-square)](https://opensource.org/licenses/Apache-2.0)![](https://img.shields.io/github/release/Qiskit/qiskit-tutorials.svg?style=popout-square)![](https://img.shields.io/github/downloads/Qiskit/qiskit-tutorials/total.svg?style=popout-square)
54

65
Welcome to the [Qiskit](https://www.qiskit.org/) tutorials!
76

87
In this repository, we've put together a collection of Jupyter notebooks aimed at teaching people who want to use Qiskit for writing quantum computing programs, and executing them on one of several backends (online quantum processors, online simulators, and local simulators). The online quantum processors are the [IBM Q](https://quantumexperience.ng.bluemix.net/qx/devices) devices.
98

10-
## Installation and Setup
9+
## Installation
1110

1211
The notebooks for these tutorials can be viewed here on GitHub. But for the full experience, you'll want to interact with them!
1312

1413
The easiest way to do this is using [the Binder image](https://mybinder.org/v2/gh/Qiskit/qiskit-tutorial/master?filepath=index.ipynb), which lets you use the notebooks via the web. This means that you don't need to download or install anything, but it also means that you should not insert any private information into the notebooks (such as your API key). We recommend as pointed out in [issue #231](https://github.com/Qiskit/qiskit-tutorial/issues/231) that after you are done using mybinder that you regenerate your token.
1514

1615
Please refer to this [installation guide](INSTALL.md) for setting up Qiskit and the tutorials on your own machine (this is the recommended way).
1716

18-
***
19-
2017
## Contents
18+
2119
We have organized the tutorials into two sections:
2220

2321
### 1. [Qiskit notebooks](qiskit/)<a id='qiskit'></a>
22+
2423
We've collected a core reference set of notebooks in this section outlining the features of Qiskit. We will be keeping them up to date with the latest Qiskit version.
2524
- [Basics](qiskit/basics) is meant for those who are getting started.
2625
- [Terra](qiskit/terra) is meant for those who want to study circuits.
@@ -29,6 +28,7 @@ We've collected a core reference set of notebooks in this section outlining the
2928
- [Jupyter](qiskit/jupyter) is meant to highlight some cool Juypter features.
3029

3130
### 2. [Community notebooks](community/)<a id='community'></a>
31+
3232
Teaching quantum computing and qiskit has many different paths of learning. We love our community, and we love the contributions so keep them coming. Because Qiskit is changing so much, at the moment we cant keep this updated, but there are some great notebooks in here. See:
3333
- [Hello, Quantum World](community/hello_world/) learn from the community how to write your first quantum program.
3434
- [Quantum Games](community/games/), learn quantum computing by having fun.
@@ -41,19 +41,14 @@ To go through the tutorials, load up the [index.ipynb](index.ipynb) notebook and
4141

4242
## Contribution guidelines
4343

44-
If you'd like to contribute to Qiskit, please take a look at our
44+
If you'd like to contribute to Qiskit Tutorials, please take a look at our
4545
[contribution guidelines](.github/CONTRIBUTING.rst). This project adheres to Qiskit's [code of conduct](.github/CODE_OF_CONDUCT.rst). By participating, you are expect to uphold to this code.
4646

47-
We use [GitHub issues](https://github.com/Qiskit/qiskit-terra/issues) for tracking requests and bugs. Please use our [slack](https://qiskit.slack.com) for discussion and simple questions. To join our Slack community use the [link](https://join.slack.com/t/qiskit/shared_invite/enQtNDc2NjUzMjE4Mzc0LTMwZmE0YTM4ZThiNGJmODkzN2Y2NTNlMDIwYWNjYzA2ZmM1YTRlZGQ3OGM0NjcwMjZkZGE0MTA4MGQ1ZTVmYzk). For questions that are more suited for a forum we use the Qiskit tag in the [Stack Overflow](https://stackoverflow.com/questions/tagged/qiskit).
48-
49-
### Next Steps
50-
51-
Now you're set up and ready to check out some of the other examples from our
52-
[Qiskit Tutorial](https://github.com/Qiskit/qiskit-tutorial) repository.
47+
We use [GitHub issues](https://github.com/Qiskit/qiskit-tutorials/issues) for tracking requests and bugs. Please use our [slack](https://qiskit.slack.com) for discussion and simple questions. To join our Slack community use the [link](https://join.slack.com/t/qiskit/shared_invite/enQtNDc2NjUzMjE4Mzc0LTMwZmE0YTM4ZThiNGJmODkzN2Y2NTNlMDIwYWNjYzA2ZmM1YTRlZGQ3OGM0NjcwMjZkZGE0MTA4MGQ1ZTVmYzk). For questions that are more suited for a forum we use the Qiskit tag in the [Stack Overflow](https://stackoverflow.com/questions/tagged/qiskit).
5348

5449
## Authors
5550

56-
Qiskit Terra is the work of [many people](https://github.com/Qiskit/qiskit-terra/graphs/contributors) who contribute
51+
Qiskit Terra is the work of [many people](https://github.com/Qiskit/qiskit-tutorials/graphs/contributors) who contribute
5752
to the project at different levels.
5853

5954
## License

0 commit comments

Comments
 (0)