Translations on Wafrn, and how to contribute

Wafrn is slowly working on internationalization, or more specifically translatable strings. Whilst many parts of the UI are still untranslated, we've been slowly building a set of strings to translate. Said strings can be viewed on Codeberg.

At the time of writing, we have an English and a Polish translation. The English translation should be used as reference; When we add strings, they are added to the English translation first.

Getting started with translating is pretty easy. If you know your way around Git and GitHub, GitLab, Codeberg and similar sites already, just send us a PR with your strings in a file named after the country code.

If you don't know your way around Git and Codeberg yet, here's the quick-start guide:

  1. Sign up for CodeBerg at https://codeberg.org/, then visit https://codeberg.org/wafrn/wafrn and look for the "fork" option/button.

  2. It will ask you some questions, but these can all be left as the default really.

  3. It will load, then redirect you to a page like https://codeberg.org/YOURUSERNAME/wafrn.

  4. Here first select the "development" branch which contains the latest translations.

The branch selector on Codeberg, with two arrows pointing to the "main" button first then to the "development" button second

  1. From here, navigate to packages/frontend/src/assets/i18n where you will see the different language files.

The list of translations in Codeberg

  1. Click on en.json, and once it has opened press the download button.

The download button's location on the page

  1. On your computer rename en.json to your country's 2-letter language code.

  2. Go back to packages/frontend/src/assets/i18n on Codeberg, then click "Add File", and "Upload file".

The upload file button location on the page

  1. On the next page upload your new file at the top, then click "Commit changes" at the bottom

The upload commit page, including two arrows pointing to the upload section and the Commit changes button

  1. Go back to packages/frontend/src/assets/i18n on Codeberg again, click your freshly uploaded file, then press the "Edit file" icon.

The edit button's location on the page

  1. Now you can start translating!

    1. Change the strings to represent roughly the same content in your language.
    2. Once you're done, add a meaningful title to your Commit
    3. Select "Create a branch for this commit and start a pull request"
    4. Enter a meaningful name (use only lowercase letters, and use dashes instead of space, like add-translation-hu)
    5. Finally click the "Propose file change" button at the bottom.

A picture with five arrows, each pointing to the relevant section on the screenshot for the five steps described above in order

  1. On the resulting page you'll need to set up your Pull Request.

    • First select the destination button, and make sure it's pointing to wafrn:development.
    • There are a lot of options usually so you might have to use the search functionality present.
    • Once selected click "New pull request"

A picture with three arrows, the first pointing to the destination box, the second to the search functionality, and the third to "wafrn:development", the destination we want to use

  1. Finally enter the pull request details.

    • Please use a meaningful title
    • Also add any relevant details to the description box
    • Once ready click on "Create pull request"

A picture showing the new PR page with filled in details as if the user was trying to create a PR for a new Hungarian translation. The "Create pull request" button is visible too

  1. You're done!