Skip to content

Latest commit

 

History

History
72 lines (44 loc) · 5.74 KB

GETTING_STARTED.md

File metadata and controls

72 lines (44 loc) · 5.74 KB

Getting started

Thank you for volunteering to translate Node.js content to your language!

By translating Node.js content (website, docs, tutorials), you are directly impacting developers around the world. Your efforts will help developers in more countries to learn Node.js! Thank you so much for volunteering your time!

(Note: If you want to help with the APIs that make Node.js applications internationalized, see instead the i18n API guide.)

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

The following is a set of guidelines for contributing to Node.js localization effort.

i18n projects

Name GitHub Managers team Crowdin URL
API Documentation nodejs/i18n @nodejs/crowdin-managers-api-docs api-docs nodejs.org/docs/latest/api
Website nodejs/nodejs.org @nodejs/crowdin-managers-website nodejs-website nodejs.org
New website nodejs/nodejs.dev @nodejs/crowdin-managers-website-dev nodejs-website-dev nodejs.dev

Translation process

The Node.js localization effort uses Crowdin, an awesome platform for collaborative translation. It keeps the translation and development aspects separate, so you don't need to think about technical stuff if you're simply wanting to help localize content. To get started, log in to Crowdin with your GitHub account, then open one of these projects to translate:

For more information on how to work with Crowdin, please read the official guide for volunteer translators or watch the video prepared by Andriy Poznakhovskyy (a member of the Node.js i18n WG).

Step #1: Translation

After successfully logging in to Crowdin and selecting a project to translate, find your language on the list.

NOTE: If you cannot find your locale in list, please create a new issue in base repo (see table) with mention to managers team

All translations are made on Crowdin are automatically pushed to the GitHub repository by an integration, so you don't need to go outside the Crowdin platform to translate content. Specifically, do not open pull requests with content translations!

NOTE: If you find an error in the original docs, feel free to open PR to the base repository (see table).

Step #2: Proofread

We really appreciate any contribution, but should validate translated content, so after you submit your translation, it will be reviewed by another translator with the “proofreader” role. Find more about roles in roles guideline.

Step #3: Sync

Crowdin automatically creates and updates a pull request to this GitHub repository within 24 hours after the updates are approved. If you think that something is going wrong with the sync process, please create a new issue here.

Communication process

We have several ways to communicate:

Feel free to choose the method that is most comfortable for you, but we recommend using GitHub issues for most cases as it is managed by the i18n-WG community.

The localization process for each language sometimes raises specific questions that should be discussed. For this reason, we've created l10n teams for each current active locale (language). The main goal of these groups is to gather people interested in taking part in the translation process in one place so that they can help each other when questions or issues arise during the translation process. To contact a specific l10n team, all you need is an account on GitHub.

NOTE: You don't have to be a member of the i18n working group to start translating, all you need is a GitHub account.


Check next guideline about roles in Node.js localization.