3 2.18 Contribute Translations
github-actions[bot] edited this page 2026-10-29 20:03:02 +00:00

Contribute Translations

How to add or update translations for Super Productivity.

Translations are JSON files in src/assets/i18n/. English (en.json) is the source and fallback: missing keys show the English text. An empty string ("") is shown as blank text, so leave untranslated keys out instead.

Steps

  1. Add or update the source string in src/assets/i18n/en.json.
  2. Do not edit another locale file directly. Those files are managed through the translation script and direct edits may be overwritten.
  3. Run the app locally (2.11-Run-the-Development-Server) and check the UI.
  4. Follow docs/i18n-script-usage.md if the locale files need to be propagated or a translation work-in-progress file needs to be extracted and merged.
  5. Submit a pull request.

Format and Conventions

  • Keep the existing nested JSON structure and SCREAMING_SNAKE_CASE keys.
  • Prefer short, clear text (UI space is limited).
  • Edit en.json directly; use the script workflow for every other locale.

Translation Tooling

For finding missing keys and keeping files in sync, use the script described in the repo:

docs/i18n-script-usage.md (and tools/add-missing-i18n-variables.js).

Full contributor notes: docs/TRANSLATING.md.