dashie
/
reel2bits
mirror of https://github.com/rhaamo/reel2bits/
Watch 1
Star 0
Fork 0
Code Issues 0 Releases 0 Wiki Activity
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.
2004 Commits
8 Branches
193 MiB
Branch: master
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'master'
${ noResults }
reel2bits/TRANSLATORS.rst

58 lines
2.8 KiB
Raw Permalink Blame History 

  1. Translating reel2bits

  2. =====================

  3. 

  4. Thank you for reading this! If you want to help translate reel2bits,

  5. you found the proper place :)

  6. 

  7. Translation workflow

  8. --------------------

  9. 

  10. Once you're logged-in on the Weblate instance, you can suggest translations. Your suggestions will then be reviewed

  11. by the project maintainer or other translators to ensure consistency.

  12. 

  13. Guidelines

  14. ----------

  15. 

  16. Respecting those guidelines is mandatory if you want your translation to be included:

  17. 

  18. - Use gender-neutral language and wording

  19. 

  20. Submitting a new language

  21. -------------------------

  22. 

  23. 1. Pull the latest version of ``master``

  24. 2. Create a new branch, e.g ``git checkout -b translations-new-fr-ca``

  25. 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.

  26. 4. Create the ``po`` file from template:

  27. 

  28. .. code-block:: shell

  29. 

  30.     export LOCALE=fr_CA  # replace with your actual locale code

  31.     mkdir -p front/locales/$LOCALE/LC_MESSAGES

  32.     msginit --no-wrap --no-translator --locale=$LOCALE --input=front/locales/app.pot --output-file=front/locales/$LOCALE/LC_MESSAGES/app.po

  33. 

  34. 5. Then commit your changes, push, and submit a pull request on the ``master`` branch

  35. 

  36. Requesting a new language

  37. -------------------------

  38. 

  39. If you cannot submit a new language yourself, you can request it by opening an issue here:

  40. https://github.com/reel2bits/reel2bits/issues

  41. 

  42. Extracting messages from source

  43. -------------------------------

  44. 

  45. We offer a script to update existing ``po`` and ``pot`` files with new translations

  46. from the source code. This action should be run regularly, and in particular before

  47. lots of translation work is expected (e.g a few weeks before a new release), or when

  48. the UI code changes a lot. Otherwise, translators end up translating some obsolete messages,

  49. or not translationg new messages.

  50. 

  51. 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

  52. 2. `Commit and push changes from weblate <https://weblate.sigpipe.me/projects/reel2bits/frontend/#repository>`_ (``Commit`` and ``Push`` buttons in the sidebar)

  53. 3. Pull ``master`` in your local git repository to ensure you have the latest version of the translations

  54. 4. Create a dedicated branch with ``git checkout -b translations-integration``

  55. 5. Extract the translations with ``cd front && ./scripts/i18n-extract.sh``. This will update all ``po`` files as necessary

  56. 6. Review, commit and push the changes, then open a merge request on the ``master`` branch

  57. 7. When the PR is merged, `Unlock the translations on weblate <https://weblate.sigpipe.me/projects/reel2bits/frontend/#repository>`_ (``Unlock`` button in the sidebar).