Skip to content

Latest commit

 

History

History
61 lines (38 loc) · 3.33 KB

README.md

File metadata and controls

61 lines (38 loc) · 3.33 KB
Raw

reactjs.org Translation

This repo contains resources and scripts to enable translations of https://reactjs.org.

Contributing to translations

Check www.isreacttranslatedyet.com to see if your language already has a translation effort in progress. Click on "Track Progress" on the language you want to contribute to in order to receive further instructions.

Starting a new translation

If you would like to be the maintainer of a new translation, submit a PR adding a new file {lang-code}.json to the langs folder with the following information:

  • Language name (in English please)
  • Language code
  • List of maintainers

For example:

{
  "name": "English",
  "code": "en",
  "maintainers": ["gaearon", "tesseralis"]
}

In the PR comment, please describe your experiences with translation (e.g. links to previous work). We prefer more than one maintainer on each repo, so if you're by yourself, we'll leave the PR open for others to join in. If you are a group, please have at least one person other than the PR opener comment, to make sure all people listed actually want to be part of the translation!

Also, please read the Maintainer Responsibilities and make sure that you are comfortable with the responsibilities listed.

Once the PR is accepted, the bot will:

  • Create a new repository for you at reactjs/{lang-code}.reactjs.org
  • Add/invite all maintainers listed to a "reactjs.org {language} Translation" team in the reactjs organization
  • Create an issue from PROGRESS.template.md in the new repository to track your translation progress

If you are not a member of the reactjs organization, you should receive an email invite to join. Please accept this invite so you can get admin access to your repository!

You may want to pin the generated issue to make it easier to find.

See Maintainer Tips for additional advice on how to manage your repository.

Happy translating!

Adding a maintainer

If you are currently a maintainer of a translation and want to add another member, send a pull request to this repo updating langs/{lang-code}.json, where {lang-code} is the language code of the repo you want to be a maintainer of.

If you are interested in becoming a maintainer for a translation, please ask one of the current maintainers if they would like to add you. While different maintainers can have different requirements, usually they look for people who have already contributed to the translation already, either by translating or reviewing.

Before publishing

  1. Review your translations and make sure that the pages listed in "Core Pages" are fully translated. Run the site yourself locally to make sure there are no bugs or missing translations.
  2. ask {TBD} to add {lang-code}.reactjs.org as a subdomain.
  3. submit a PR to reactjs/reactjs.org adding the language in the dropdown (once we make it).
  4. Celebrate! 🎉🌐

Acknowledgements

This repo, and the bot that makes all this possible, is based off of and iterated upon che-tsumi by the Vue.js Japan User Group.