Skip to content

Commit ee0076a

Browse files
authored
Merge pull request #1482 from github/translator-setup
Translators need to set up their environment, can send in progress PR
2 parents a1336dc + f0a6433 commit ee0076a

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

docs/translations.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,13 @@ Before you start working on a translation, look through the [open pull requests]
99
If there's not, then today is your day to lead this effort! Here's how to start:
1010

1111
1. [Fork this repository](https://github.com/github/opensource.guide/fork)
12+
1. [Set up your environment](../CONTRIBUTING.md#setting-up-your-environment)
1213
1. Create a new branch for your translation work e.g. `es`.
1314
1. Copy `_data/locales/en.yml` to your target language file e.g. `_data/locales/es.yml` and translate all the strings.
1415
1. 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 remain unchanged. Remove the `toc:` fields (they are only used for English).
1516
1. 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:` fields. Example: `lang: es` and `permalink: /es/`. All other fields' values must remain unchanged.
1617
1. Run `script/test` and make sure there are no failures with your translation files. Note that you may need to fix broken links.
17-
1. Send a pull request.
18+
1. Send a pull request. (You may send a pull request before all steps above are complete: e.g., you may want to ask for help with translations, or getting tests to pass. However your pull request will not be merged until all steps above are complete.)
1819

1920
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](https://github.com/katrinleinweber/opensource.guide/pulls?q=is%3Apr+is%3Aclosed) and corresponding [initial pull request for German translation](https://github.com/github/opensource.guide/pull/577) on this repository.
2021

0 commit comments

Comments
 (0)