Skip to content

Contribute a Translation via GitHub

Stefan Seifert edited this page Apr 28, 2023 · 3 revisions

Overview

This page describes how to contribute a translation to a brdgm.me Solo Helper Application. It uses the Ark Nova Solo Helper as example, but works for all applications found in GitHub.

This page describes a simple approach which allows you to provide a translation via GitHub without further testing. If you are adventurous, you can also try the advanced approach via Codespaces.

Create GitHub Account

If you do not have a GitHub account, go to https://github.com and create one via "Sign up" - it's free!

github-signup

Identify the English master file

Each Solo Helper Application has an English master file located inside the code repository at src/locales/en.json. You find all GitHub repositories of the applications at https://github.com/brdgm.

The English Master file for Ark Nova is located at https://github.com/brdgm/ark-nova-solo-helper/blob/develop/src/locales/en.json

Download the master file

Download the master file via the "Raw" button. Save it with the 2-letter ISO 639-1 language code of the target language (e.g. "fr.json" for french).

github-download-raw-file

Translate the file

Translate all strings in the JSON file into the target language.

See JSON Translation File Semantics for details on the conventions used in the file.

Upload the file to GitHub

Go back to the master file in GitHub, e.g. The English Master file for Ark Nova is located at https://github.com/brdgm/ark-nova-solo-helper/blob/develop/src/locales/en.json

Click on the edit button and paste the content of your translated file into the text field, overwriting the English content.

Overwrite the file name and put in the new file name with the 2-letter language code.

github-edit-file-name

Complete the pull request by providing a message in the "Propose changes" text box at the bottom of the screen, and click on the "Propose changes" button:

github-edit-file-finish

That's all.

Sidenote: Technically this creates a pull request that renames and overwrites the English master file. But we will sort this out before merging it in the main code base.