Skip to content
This repository has been archived by the owner on Feb 8, 2024. It is now read-only.

Latest commit

 

History

History
96 lines (62 loc) · 7.92 KB

TRANSLATING.md

File metadata and controls

96 lines (62 loc) · 7.92 KB
Raw

Qiskit Textbook Localization

First of all, thank you for showing interest in translating (localizing) Qiskit Textbook! Your effort helps make the textbook 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 Documentation. For signing up to join the Qiskit Documentation Localization project, please refer the steps outlined here.

$$\color{#D22222}\textsf{\Large⚠\kern{0.2cm}\Large No new joining requests will be accepted in GitLocalize.}$$

$$\color{#D22222}\textsf{\qquad\kern{0.2cm}\Large This is due the upcoming changes on Qiskit Textbook.}$$

If you are interested in contributing to translating the Qiskit Textbook, please follow the instructions below.

Steps to participate in Qiskit textbook translations:

  1. Open the LOCALIZATION_CONTRIBUTORS file. Look for the language header that you'd like to contribute to and add your full name under the header. 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 PR.
    Each contributor must create their own PR and sign the Contributors License Agreement (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. Join GitLocalize using the same GitHub ID you used to open your PR above.

  5. Leave a comment in your PR stating that you successfully joined GitLocalize.

  6. Once your PR has been accepted and merged, you will receive a notification from GitLocalize with a title: [GitLocalize] You have been assigned a new role.

  7. Join project [Qiskit/platypus] and then visit the language you signed up to contribute to.

  8. For questions about the project, to connect with other translators, or to receive updates regarding the project, please join #qiskit-localization channel in the Qiskit workspace.

Review the CLA document

The Qiskit Contribution License Agreement (CLA) document is also available for review as PDF.

What is GitLocalize?

GitLocalize is a platform for managing translations of the content stored on GitHub and simplifies the translation workflow for developers.

Important note:
Gitlocalize is under active development, so you may encounter issues during translation. If you find bugs or errors, please feel free to reach out to translation leads or open an issue here.

How to add a new language?

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.

What is the criteria for adding a new language?

  1. A minimum of three contributors is necessary for any new language to be added and receive official support from the administrators of the Qiskit Textbook localization project.
  2. In addition to translators, we will need dedicated proof-readers to review the translations and approve accuracy of content in that language, to ensure the translations can be released in that language.
  3. 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 for the language to be officially listed under this project.

These are general guidelines for joining translation efforts and adding new languages. However, please note that the above does not guarantee that a language will be opened. If you have further questions, please feel free to contact Soolu Thomas and Yuri Kobayashi. Thank you.

How to add my name to LOCALIZATION_CONTRIBUTORS list and open a PR in GitHub?

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 (steps 3, 4, 5, 6).

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/platypus (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.

When will my translation get published?

Please refer to the Release Guide for more information on how translated textbooks get published.

When you find an issue in the textbook

During the process of translating Qiskit Textbook, you may identify bug or errors regarding the original textbook content. Please feel free to suggest corrections by opening an issue.

Project Leads

Name Slack (Qiskit Workspace)
Yuri Kobayashi @Yuri Kobayashi
Soolu Thomas @Soolu
Sophy Shin @Sophy

Translation Leads (as of April 2022)

Language Translation Leads Slack (Qiskit Workspace)
Portuguese (PT_UN) Omar Costa Hamido @OCH
Spanish (ES_UN) Claudia Zendejas-Morales, Rodrigo Rosado Rivial @clausia @rodrigo rosado