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

Commit

Permalink
Merge pull request #475 from jaygambetta/master
Browse files Browse the repository at this point in the history
updating readme and contribute
  • Loading branch information
nonhermitian authored Dec 27, 2018
2 parents 2977655 + bceb966 commit 5db85b4
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 19 deletions.
34 changes: 34 additions & 0 deletions .github/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
Contributing
===============

If you would like to contribute to the Qiskit-tutorials, there are a number of ways to
get involved:

* **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.

* **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 requests <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.

Contributor License Agreement
-----------------------------

We'd love to accept your code! Before we can, we have to get a few legal
requirements sorted out. By signing a contributor license agreement (CLA), we
ensure that the community is free to use your contributions.

When you contribute to the Qiskit Terra 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 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 qiskit@us.ibm.com.
34 changes: 15 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,25 @@

<img src="images/qiskit-heading.gif" >

***


# Qiskit Tutorials
[![License](https://img.shields.io/github/license/Qiskit/qiskit-tutorials.svg?style=popout-square)](https://opensource.org/licenses/Apache-2.0)
[![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/QISKit/qiskit-tutorial/master?filepath=index.ipynb)

[![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)

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

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.

## Installation and Setup
## Installation

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

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.

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

***

## Contents

We have organized the tutorials into two sections:

### 1. [Qiskit notebooks](qiskit/)<a id='qiskit'></a>

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

### 2. [Community notebooks](community/)<a id='community'></a>

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:
- [Hello, Quantum World](community/hello_world/) learn from the community how to write your first quantum program.
- [Quantum Games](community/games/), learn quantum computing by having fun.
Expand All @@ -45,16 +39,18 @@ Teaching quantum computing and qiskit has many different paths of learning. We l

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

***
## Contribution guidelines

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

* **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.
* **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.
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).

## Contributors
These tutorials are the work of our [Qiskitters](https://github.com/Qiskit/qiskit-tutorial/graphs/contributors) who contribute to the project at different levels.
## Authors

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

## License
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.

[Apache License 2.0](LICENSE.txt)

0 comments on commit 5db85b4

Please sign in to comment.