⚠️ This repository is not a package.: The setup.py file is only in this repository as a requirement for building docs. If you'd like to install Qiskit, follow the link.

First of all, thank you for showing interest in translating (localizing) Qiskit Documentation! This helps make the documentation more accessible and available to our global community.

👀 Please note that you must sign up separately if you want to join the localization project for Qiskit Textbook. For signing up to join the Qiskit Textbook Localization project, please refer the steps outlined here.

If you are interested in contributing to Qiskit Documentation translations, please follow the instructions below.

1. Open the LOCALIZATION_CONTRIBUTORS file. Look for the language header that you'd like to contribute to and sign up under there. If you do not find the language that you'd like to contribute to, please read this section.
   

2. Create a pull request (PR) to add your name to the list. Make sure to follow the template to open a Pull Request.
   

   • Each contributor has to create their own PR and sign the CLA (see #3 below).
   • If you have an open issue for a language request, add the issue link to the PR.

   (Not sure how to open a PR? Checkout this section)

3. When you conribute to a Qiskit open source project on GitHub with a new pull request, a bot will evaluate whether you have signed the Qiskit Contribution License Agreement (CLA). If it is your first time contributing to Qiskit, you will be prompted to sign the CLA in your PR. Please make sure to sign the CLA by accepting the agreement.

4. In the Qiskit-Docs Crowdin project, choose the language that you want to contribute to.
   

5. Click the Join button and paste the URL of your PR in the dialog box where you are asked why you want to join the Crowdin project. Failing to do so will result in a delay in approving your request in Crowdin and your Pull Request in GitHub. The administrators of the Crowdin project will review your request and give you access as quickly as they can.
   

6. For questions regarding onboarding or strategy, to connect with other translators and receive updates regarding the project please join #qiskit-localization channel in the Qiskit workspace or make an issue in this repo.

Qiskit documentation is translated (localized) using Crowdin, a software and web localization platform that allows organizations to coordinate translation projects and collaborate with communities to translate materials. Crowdin allows our community of translators to amplify their impact by automatically reusing the work invested in translating one sentence, to translate other, similar sentences. Crowdin also makes translations resilient to many types of changes to the original material, such as moving sentences around, even across files.

The list of languages that Qiskit Documentation Localization Project currently supports can be seen in the Crowdin project page. These translations can be viewed from our staging site.

Japanese, German, Korean, Portuguese, French and Tamil documentation are now available in the Qiskit Documentation website.

The Machine Learning application tutorials are available in Bengali, French, Hindi, Italian, Japanese, Korean, Malayalam, Russian, Spanish, Tamil, Turkish, Vietnamese

As mentioned in the blog post Qiskit in my language is Qiskit, we want to make sure that translated languages have enough community support to ensure quality and consistency.

If you want to add a new language and become a translation lead, you can open a GitHub issue to start a discussion with the Qiskit team and recruit translation project members. Please refer to the criteria below to receive official support from the administrators for new languages.

1. A minimum of five contributors is necessary for any new languages to be added and receive official support from the administrators of the localization project.
   
2. One of the contributors in that language must be a Qiskit Advocate and should actively participate.
   
3. In addition to translators, we will need dedicated proof-readers to review the translations and approve accuracy of content in that language and to ensure that the translations can be released in that language.
   
4. Among the group of contributors, a translation lead must be identified to serve as a liaison with the administrators of the localization project. The lead must contact Soolu Thomas and Yuri Kobayashi by email containing the issue number (or link) and, a little intro about the TL(s) and the team after the above three criteria are met.
   
5. The project administrators will schedule a meeting with the translation lead(s) of the proposed language. Please note that satisfying the minimum number of translators does not automatically make the language ready to be added to Crowdin. It will be very important for the team to make continuous progress and to be active.

These are general guidelines for joining translation efforts and adding new languages. If you have further questions, please feel free to contact Soolu Thomas and Yuri Kobayashi. Thank you.

Option 1: In Github (Recommended)

1. Click on the pen-like button which says "Edit this file" in the LOCALIZATION_CONTRIBUTORS file.
2. Add your name under the language you'd like to contribute to.
3. Once your name is added, scroll down and find a green button which says "Propose changes".
4. The page now reloads automatically and find and click on another green button - "Create pull request".
5. This should create the pull request and once that's done, follow the instructions (step 3, 4, 5).

Option 2: Creating a local clone of the repository and pushing from local

1. Clone this repository by following this guide.
2. Make sure your local git configuration by following the instructions here -- Setting username and Setting email
3. Create a branch by running git checkout -b BRANCH_NAME in your terminal.
4. Find LOCALIZATION_CONTRIBUTORS file in your local copy of qiskit-translations (created after cloning this repository) and add your name under the language you'd like to contribute to.
5. Now, in the terminal run git add LOCALIZATION_CONTRIBUTORS, git commit -m "Added name under LANGUAGE-NAME", git push origin BRANCH-NAME.
6. Follow the link in the terminal to open a pull request.

At Qiskit, we feel that it is important to recognize the contributions that were made by its members to make our documentation more accessible to the global community. Starting in 2020, localization contributors who drove efforts in translating, proof-reading and managing progress can earn a Qiskit Localization Contributor Badge. For details, please refer to Qiskit Localization Digital Badges.

During the process of translating Qiskit documentation, you may identify errors (mostly typos) in the original documentation. Please feel free to suggest corrections by opening an issue and choose Documentation.