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

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 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 GitHub yet, here's the quick-start guide:

Now, depending on whether you used GitHub Desktop or are editing in a web browser, the next step will differ slightly:

GitHub Desktop

Input a summary/title for your changes and hit "commit to main" in the bottom left.

The Github desktop commit interface, with the title set to 'add bottom language' and the summary set to ':trollface:'. There is a cursor on the 'commit to main' button.

If it asks you to publish your branch, do so! You can't continue otherwise.

Next, it may show you something like this:

'Preview the Pull Request from your current branch' in a Github desktop info field. There is a 'Preview pull request' button to the right of the title and description.

If not, navigate to Branch → Preview Pull Request at the top of the window:

the 'Preview Pull Request' option is highlighted in a drop-down menu of the GitHub desktop application.

Either way, you should see a page like this:

The 'Preview Pull request' GitHub Desktop popup, showing changes made and offering options to create a PR or cancel.

Hit "Create Pull Request" and it will redirect you to the GitHub webpage, with your proposal ready to be written:

the GitHub 'create pull request' page. It's filled out with some example text.

Nothing fancy is required here! Just give it a title like Add [some language], a small description if there's anything else that you think may be relevant, and make sure to scroll down that the files you want to be there are actually present!

Once you're ready, hit Create Pull Request.


GitHub's Web Editor

If you've ever used VSCode you'll feel right at home. Welcome to the GitHub Web Editor!

GitHub automatically saves edits here, and instead of committing them locally they will be uploaded to GitHub automatically. So once you've edited your translations file, head over to the "Source Control" section on the left:

the GitHub Web Editor 'Source Control' icon is hovered by a cursor.

You should then see something akin to this:

the Github Web Editor 'Source Control' panel with one change and an empty text box.

Put in a Title for your change into the 'Message' box, then hit "Commit & Push"!

Once you've done that, navigate back to https://github.com/YOURUSERNAME/wafrn and you should see a banner such as this one:

the GitHub 'there was recent pushes to branch' banner.

Click on it, and you should be lead to a page like this:

the GitHub 'create pull request' page. It's filled out with some example text.

Give it a title like 'Added [language] translation', a description if you need one, and scroll down to be sure your changes are actually included!

Once you're ready, hit Create Pull Request.