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

Commit 5db85b4

Browse files
authored
Merge pull request #475 from jaygambetta/master
updating readme and contribute
2 parents 2977655 + bceb966 commit 5db85b4

File tree

2 files changed

+49
-19
lines changed

2 files changed

+49
-19
lines changed

.github/CONTRIBUTING.rst

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
Contributing
2+
===============
3+
4+
If you would like to contribute to the Qiskit-tutorials, there are a number of ways to
5+
get involved:
6+
7+
* **Issues**: Issues can be reported with GitHub `issue
8+
reporting <https://github.com/Qiskit/qiskit-tutorial/issues>`_ for this repository.
9+
Select `New issue`, fill in a descriptive title, and provide as much detail
10+
as is needed for the issue to be reproduced.
11+
12+
* **Notebooks**: If you would like to contribute a notebook, please
13+
create a `fork <https://help.github.com/articles/fork-a-repo/>`_ of the repository
14+
from the `master` branch and create a
15+
`pull requests <https://help.github.com/articles/about-pull-requests>`_ for your change.
16+
Note that new notebooks should be placed in the relevant part of the
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: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,25 @@
1-
2-
<img src="images/qiskit-heading.gif" >
3-
4-
***
5-
6-
71
# Qiskit Tutorials
8-
[![License](https://img.shields.io/github/license/Qiskit/qiskit-tutorials.svg?style=popout-square)](https://opensource.org/licenses/Apache-2.0)
9-
[![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/QISKit/qiskit-tutorial/master?filepath=index.ipynb)
102

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)
114

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

147
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.
158

16-
## Installation and Setup
9+
## Installation
1710

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

2013
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.
2114

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

24-
***
25-
2617
## Contents
18+
2719
We have organized the tutorials into two sections:
2820

2921
### 1. [Qiskit notebooks](qiskit/)<a id='qiskit'></a>
22+
3023
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.
3124
- [Basics](qiskit/basics) is meant for those who are getting started.
3225
- [Terra](qiskit/terra) is meant for those who want to study circuits.
@@ -35,6 +28,7 @@ We've collected a core reference set of notebooks in this section outlining the
3528
- [Jupyter](qiskit/jupyter) is meant to highlight some cool Juypter features.
3629

3730
### 2. [Community notebooks](community/)<a id='community'></a>
31+
3832
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:
3933
- [Hello, Quantum World](community/hello_world/) learn from the community how to write your first quantum program.
4034
- [Quantum Games](community/games/), learn quantum computing by having fun.
@@ -45,16 +39,18 @@ Teaching quantum computing and qiskit has many different paths of learning. We l
4539

4640
To go through the tutorials, load up the [index.ipynb](index.ipynb) notebook and start learning.
4741

48-
***
42+
## Contribution guidelines
4943

50-
## Contributing
51-
If you would like to contribute to the tutorials, there are a number of ways to get involved:
44+
If you'd like to contribute to Qiskit Tutorials, please take a look at our
45+
[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.
5246

53-
* **Issues**: Issues can be reported with GitHub [issue reporting](https://github.com/Qiskit/qiskit-tutorial/issues) for this repository. Select `New issue`, fill in a descriptive title, and provide as much detail as is needed for the issue to be reproduced.
54-
* **Notebooks**: If you would like to contribute a notebook, please create a [fork](https://help.github.com/articles/fork-a-repo/) of the repository from the `master` branch and create a [pull request](https://help.github.com/articles/about-pull-requests/) for your change. Note that new notebooks should be placed in the relevant part of the [Community](community/) section.
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).
5548

56-
## Contributors
57-
These tutorials are the work of our [Qiskitters](https://github.com/Qiskit/qiskit-tutorial/graphs/contributors) who contribute to the project at different levels.
49+
## Authors
50+
51+
Qiskit Terra is the work of [many people](https://github.com/Qiskit/qiskit-tutorials/graphs/contributors) who contribute
52+
to the project at different levels.
5853

5954
## License
60-
This project is licensed under the Apache License 2.0 - see the [LICENSE](https://github.com/QISKit/qiskit-tutorial/blob/master/LICENSE) file for details.
55+
56+
[Apache License 2.0](LICENSE.txt)

0 commit comments

Comments
 (0)