diff --git a/translations/README.md b/translations/README.md index 31499f49..48400a48 100644 --- a/translations/README.md +++ b/translations/README.md @@ -1,10 +1,9 @@ # Translations -The base translation is `base-en.yaml`. It will always contain the latest phrases and structure. +The base language is English and can be found [here](base-en.yaml). ## Languages -- [English (Base Language, Source of Truth)](base-en.yaml) - [German](base-de.yaml) - [French](base-fr.yaml) - [Korean](base-kor.yaml) @@ -39,15 +38,39 @@ The base translation is `base-en.yaml`. It will always contain the latest phrase If you want to edit an existing translation (Fixing typos, Updating it to a newer version, etc), you can just use the github file editor to edit the file. -- Find the file you want to edit (For example, `base-de.yaml` if you want to change the german translation) -- Click on the file name on, there will be a small "edit" symbol on the top right -- Do the changes you wish to do (Be sure **not** to translate placeholders!) +- Click the language you want to edit from the list above +- Click the small "edit" symbol on the top right + +edit symbol + +- Do the changes you wish to do (Be sure **not** to translate placeholders! For example, ` minutes` should get ` Minuten` and **not** ` Minuten`!) + - Click "Propose Changes" -- I will review your changes and make comments, and eventually merge them so they will be in the next release! + +propose changes + +- Click "Create pull request" + +create pull request + +- I will review your changes and make comments, and eventually merge them so they will be in the next release! Be sure to regulary check the created pull request for comments. ## Adding a new language -Please DM me on discord (tobspr#5407), so I can add the language template for you. It is not as simple as creating a new file. +Please DM me on discord (tobspr#5407), so I can add the language template for you. + +Please use the following template: + +``` +Hey, could you add a new translation? + +Language: +Short code: +Local Name: +``` + +You can find the short code [here](https://www.science.co.il/language/Codes.php) (In column `Code 2`). + PS: I'm super busy, but I'll give my best to do it quickly! ## Updating a language to the latest version