Translations

Thanks for your interest in helping translating the guides!

Starting a translation

Before you start working on a translation, look through the open pull requests to see if anyone else is already working on one for your language.

If there's not, then today is your day to lead this effort! Here's how to start:

Fork this repository
Create a new branch for your translation work e.g. es.
Copy _data/locales/en.yml to your target language file e.g. _data/locales/es.yml and translate all the strings.
Create a new directory in _articles/ for your language e.g. _articles/es/, copy each guide from _articles/ into that folder and translate the content in each guide, except for the field names in the front matter between the ---s at the top of each file, e.g., title: should be unchanged.
Copy index.html to your target language index file e.g. [_articles/es/index.html](https://github.com/github/opensource.guide/blob/master/_articles/es/index.html) and update the lang: and add the permalink: field. Remove the toc: fields (they are only used for English).
Run script/test and make sure there are no failures with your translation files. Note that you may need to fix broken links.
Send a pull request.

Completing an initial translation of the whole site is a fairly large task. One way to break that task up is to work with other translators through pull requests on your fork. Example: pull requests on fork for German translation and corresponding initial pull request for German translation on this repository.