Skip to content

docs: add translations contributing note to README #422

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
LopezDev7 wants to merge 1 commit into from
Closed

docs: add translations contributing note to README #422

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,18 @@ yarn start
yarn tauri build
```

# Translations

Translations live in `src/locales/translations/`, one TypeScript file per language (e.g. `es.ts`, `ru.ts`). The English file `en.ts` is the source of truth and every language file must keep the same keys.

To add or update a language:

1. Copy `src/locales/translations/en.ts` to a new file (e.g. `xx.ts`) and translate the values, keeping the keys unchanged.
2. Register the new language in `src/locales/index.ts`: add it to `loadTranslation`, `LanguageType` and `LANGUAGE_METADATA`.
3. Open a pull request.

Missing keys fall back to English, so keeping keys in sync with `en.ts` is the only requirement.

# Donations

While open.mp is a totally free project and everyone in the team dedicates their time on this project to provide the best for the community, we can still use whatever contribution by anyone, to cover our costs or motivate developers.
Expand Down