Shane Smiskol
e441e42fc4
* Test for vanished translations * this isn't needed anymore * comment * remove more unnecessary code since the great pluralization old-commit-hash: eaf21e53e2a3e3e988b661412c919a331b5cf2a9
Multilanguage
Contributing
Before getting started, make sure you have set up the openpilot Ubuntu development environment by reading the tools README.md.
Adding a New Language
openpilot provides a few tools to help contributors manage their translations and to ensure quality. To get started:
- Add your new language to languages.json with the appropriate language code and the localized language name (Traditional Chinese is
中文（繁體）). - Generate the XML translation file (
*.ts):selfdrive/ui/update_translations.py - Edit the translation file, marking each translation as completed:
linguist selfdrive/ui/translations/your_language_file.ts - View your finished translations by compiling and starting the UI, then find it in the language selector:
scons -j$(nproc) selfdrive/ui && selfdrive/ui/ui
Improving an Existing Language
Follow step 3. above, you can review existing translations and add missing ones. Once you're done, just open a pull request to openpilot.
Updating the UI
Any time you edit source code in the UI, you need to update the translations to ensure the line numbers and contexts are up to date (first step above).
Testing
openpilot has a few unit tests to make sure all translations are up to date and that all strings are wrapped in a translation marker. They are run in CI, but you can also run them locally.
Tests translation files up to date:
selfdrive/ui/tests/test_translations.py
Tests all static source strings are wrapped:
selfdrive/ui/tests/create_test_translations.sh && selfdrive/ui/tests/test_translations
