Something something like soundcloud but not like soundcloud.
Log in, upload records, done.
Simple, easy, KISS.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

58 lines
2.8 KiB

  1. Translating reel2bits
  2. =====================
  3. Thank you for reading this! If you want to help translate reel2bits,
  4. you found the proper place :)
  5. Translation workflow
  6. --------------------
  7. Once you're logged-in on the Weblate instance, you can suggest translations. Your suggestions will then be reviewed
  8. by the project maintainer or other translators to ensure consistency.
  9. Guidelines
  10. ----------
  11. Respecting those guidelines is mandatory if you want your translation to be included:
  12. - Use gender-neutral language and wording
  13. Submitting a new language
  14. -------------------------
  15. 1. Pull the latest version of ``master``
  16. 2. Create a new branch, e.g ``git checkout -b translations-new-fr-ca``
  17. 3. Add your new language code and name in ``front/src/locales.js``. Use the native language name, as it is what appears in the UI selector.
  18. 4. Create the ``po`` file from template:
  19. .. code-block:: shell
  20. export LOCALE=fr_CA # replace with your actual locale code
  21. mkdir -p front/locales/$LOCALE/LC_MESSAGES
  22. msginit --no-wrap --no-translator --locale=$LOCALE --input=front/locales/app.pot --output-file=front/locales/$LOCALE/LC_MESSAGES/app.po
  23. 5. Then commit your changes, push, and submit a pull request on the ``master`` branch
  24. Requesting a new language
  25. -------------------------
  26. If you cannot submit a new language yourself, you can request it by opening an issue here:
  27. https://github.com/reel2bits/reel2bits/issues
  28. Extracting messages from source
  29. -------------------------------
  30. We offer a script to update existing ``po`` and ``pot`` files with new translations
  31. from the source code. This action should be run regularly, and in particular before
  32. lots of translation work is expected (e.g a few weeks before a new release), or when
  33. the UI code changes a lot. Otherwise, translators end up translating some obsolete messages,
  34. or not translationg new messages.
  35. 1. `Lock the translations on weblate <https://weblate.sigpipe.me/projects/reel2bits/frontend/#repository>`_ (``Lock`` button in the sidebar). This will prevent translators from working, and help prevent potential conflicts in the source code
  36. 2. `Commit and push changes from weblate <https://weblate.sigpipe.me/projects/reel2bits/frontend/#repository>`_ (``Commit`` and ``Push`` buttons in the sidebar)
  37. 3. Pull ``master`` in your local git repository to ensure you have the latest version of the translations
  38. 4. Create a dedicated branch with ``git checkout -b translations-integration``
  39. 5. Extract the translations with ``cd front && ./scripts/i18n-extract.sh``. This will update all ``po`` files as necessary
  40. 6. Review, commit and push the changes, then open a merge request on the ``master`` branch
  41. 7. When the PR is merged, `Unlock the translations on weblate <https://weblate.sigpipe.me/projects/reel2bits/frontend/#repository>`_ (``Unlock`` button in the sidebar).