We love contributions and need them to ensure the textbook is a high-quality resource.
To avoid duplication of effort and to ensure all discussion happens in the same place,
always check the existing issues and pull requests to see if the problem has already been addressed.
It is worth removing the
is:open filter to search through closed / merged issues too.
If you notice any spelling / grammar errors and want to fix them, then feel free to go ahead and make a pull request.
If you want to correct a scientific / mathematical / code error, make an issue first so we can discuss the changes.
Please make one pull request (using separate branches) for each issue.
We appreciate offers to contribute to the textbook, but unfortunately we can't accept new content at this time. We still think community-driven content is really valuable, and we're working to create an appropriate place for it within the textbook platform. Until then, we highly encourage you to continue to share your work through other channels.
The textbook uses jupyter book to generate the site from jupyter notebooks. To edit the pages you will first need to install jupyter and Qiskit, you can use the links below to help you do this:
If you are unfamiliar with git, you can follow this guide to making contributions:
You will need to fork the textbook, make changes in your own branch, then submit a pull request which we will review before merging. You must use jupyter notebook to edit the pages. If you change any code, please re-run the notebook (you can do this using the ⏭ button at the top of the notebook editor) to update the cell outputs.
Important: The notebooks to edit are inside the
After writing your chapter, you must add a few tags to your cells (You can see the tags using
view > tags).
If you include the chapter's title in your notebook, move this to its own cell and add a
remove_cell tag to avoid duplicate titles on the website. This is only for the title that will appear in the sidebar.
If you intentionally raise an exception in a cell, add a
raises-exception tag to that code cell so our checking script knows this is intentional.
Any code cell that uses IBM hardware, or relies on the results from such a cell needs a
uses-hardware tag to alert the user this cannot be run on the website through thebelab.
When creating graphs, you can hide the code that generated your graph on the website using the
remove_input tag. The code and graph will not be interactive, essentially embedding a static image. The pro is that this enables future editors to modify it.
Finally, after adding these tags, go to
view > none and save your notebook to stop the tags from showing automatically when a reader opens the notebook.
For a list of contributors, see the .bib file.
First of all, thank you for showing your interest in translating (localizing) Qiskit Textbook! This helps make the textbook more accessible and available to our global community. If you are interested in contributing to translations, please follow the instructions below. For detailed guidelines, please check here.
stablebranch are the latest original English documents. Please translate the latest documents and save them in the
i18n/locales/xxfolder of your language branch with the same directory structure. - Please also translate
We want to make sure that translated languages have enough community support to ensure quality and consistency.
If you have further questions, please feel free to contact Kifumi Numata. Thank you.
When new content is added to the original textbook, you can contribute to translating it to Japanese by:
Find the corresponding original file under the
content folder of the
Translate it to Japanese.
Add the translated file under the
i18n/locales/ja folder of the
master-ja branch by sending Pull resquest.
For detailed guidelines, please check here.
Table of Content