Skip to content

Commit

Permalink
add strings
Browse files Browse the repository at this point in the history
  • Loading branch information
Sacha Greif committed Sep 25, 2023
1 parent 07457aa commit 6609cc1
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
# locale-en-US

This repo contains the English language files for the State of JS/CSS/etc. surveys, which serve as a base to translate all the other languages. You can view a list of [all the locales repos here](https://github.com/StateOfJS/?q=locale-&type=&language=&sort=).
This repo contains the English language files for the State of JS/CSS/HTML/etc. surveys, which serve as a base to translate all the other languages. You can view a list of [all the locales repos here](https://github.com/orgs/Devographics/repositories?q=locale-&type=all&language=&sort=name).

## How To Help

#### 1. Becoming a Translator

To start helping translate the survey, you should [join the Discord](https://discord.com/invite/zRDb35jfrt) and DM me (`SachaG`) your GitHub username, along with the locale code (`fr-FR`, `zh-Hant`, etc.) for the language you'd like to help with.

I will then give you maintainer rights over a repo containing all the translation `yaml` files, and from now on you can manage it yourself along with other members of the translation team.
I will then give you maintainer rights over a repo containing all the translation `yaml` files, and from now on you can manage it yourself along with other members of the translation team.

#### 2. Finding Things to Translate

You can either browse the survey-taking app, survey results site, etc. and find untranslated strings this way, or else use our API to get extra data such as the completion percentage for a locale or a list of all the untranslated strings:
You can either browse the survey-taking app, survey results site, etc. and find untranslated strings this way, or else use our API to get extra data such as the completion percentage for a locale or a list of all the untranslated strings:

- https://graphiql-internal.devographics.com/
- https://graphiql.devographics.com/

Here is a sample query:
Here is a sample query:

```graphql
query GetLocaleData {
locale(localeId: "ru-RU") {
locale(localeId: ru_RU) {
completion
totalCount
translatedCount
Expand All @@ -32,19 +32,21 @@ query GetLocaleData {

#### 3. Getting Credit

Every translator will be credited on any site that makes use of the translations, starting with the survey-taking app. While this will eventually be automated via the GitHub API, for now you can add your name here:
Every translator will be credited on any site that makes use of the translations, starting with the survey-taking app. In order to receive credit, add your GitHub username to the `translators` array in each locale's `config.yml` file.

- https://github.com/devographics/monorepo/blob/main/api-internal/src/data/locales.yml
Here is an example for the `de-DE` locale:

- https://github.com/Devographics/locale-de-DE/blob/main/config.yml#L3

#### 4. Pushing Your Changes Live

There is currently no automated hook to update the production apps when a translation is updated, so for now the best way is to DM me on Discord to let me know when you're finished.
There is currently no automated hook to update the production apps when a translation is updated, so for now the best way is to DM me on Discord to let me know when you're finished.

## Translation Files

#### Surveys App

These strings are related to the app that you use to fill out the actual survey.
These strings are related to the app that you use to fill out the actual survey.

- `surveys.yml`
- `accounts.yml`
Expand Down Expand Up @@ -72,11 +74,11 @@ These strings appear in both.

## Joining Translation Teams

It's recommended you join the [translation team](https://github.com/orgs/StateOfJS/teams/translators/teams) for the language you want to translate.
It's recommended you join the [translation team](https://github.com/orgs/Devographics/teams/translators/teams) for the language you want to translate.

## Local Development

There is currently no easy way to see your strings in context while developing locally. We are working on it.
There is currently no easy way to see your strings in context while developing locally. We are working on it.

## Getting Help

Expand Down

0 comments on commit 6609cc1

Please sign in to comment.