Skip to content

Latest commit

 

History

History
69 lines (42 loc) · 5.59 KB

GETTING_STARTED.md

File metadata and controls

69 lines (42 loc) · 5.59 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!

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. This info acceptable to next Node.js localization projects:

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

Node.js localization effort uses Crowdin, an awesome platform for collaborative translation. It keeps translators and developers separately, so you don't need to think about any technical stuff if you're simply want localize content. To get started, log in to Crowdin with your GitHub account, then open one of projects to translate:

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

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 and then automatically pushed to the GitHub repository by an integration, so you don't need to go outside the Crowdin platform to translate content. 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 submitted your translation it's going to be approved by other translator with proofreader role. Find more details 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's something is going wrong with sync process please create a new issue.

Communication process

We propose a few ways to communicate:

Feel free to choose what's most comfortable for you, but we recommend using GitHub issues for most cases as it's standardized and controlled by the Node.js community.

The localization process for each language can have specific questions that should be discussed somewhere. For this reason we've created l10n teams for each current active locale. The main goal is to gather people interested in taking part in the translation process in one place so that it can be used as a source of help when problems/doubts 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 this group to start translating


Check next guideline about roles in Node.js localization.