Created Guide for translators (markdown)

Luke Vella 2022-07-17 16:32:51 +01:00
parent e7ed7a22f9
commit 6542ad8853

77
Guide-for-translators.md Normal file

@ -0,0 +1,77 @@
# Guide for translators
If you are interested in helping translate Rallly to other languages, please read this guide first.
## Before volunteering
A few things you should know:
* Translations will be done through [crowdin](https://crowdin.com). You will receive an invite to create an account and submit translations on this site.
* For translations to go live there needs to be at least two individual and independent translators who will translate and review the translations.
* This project is actively developed and that means that translations will need to be added and updated regularly. Though it is not required or expected, translators who are able to contribute regularly would be preferred.
## Becoming a translator
To become a translator you can either send an email to [luke@rallly.co](mailto:luke@rallly.co) or join our [discord chat](https://discord.gg/m5UFXavc2C) and send a direct message to @lukevella. You will need to provide the following information:
* Your name
* Language you will be translating to
* Email
* Github handle (optional: To be credited your as a translator on the project readme)
Once approved you will receive an invite to submit translations via [crowdin](https://crowdin.com) and you will get access to the private translator channel on discord where you can collaborate with other translators.
## When translating
Please try to adhere to these rules to get the best results when translating:
### Punctuation
Pay close attention to how phrases are punctuated where applicable.
```
Name:
```
If a sentence ends with a period (.) or a colon (:), you will want to include that in your translation.
```
❌ Nombre
✅ Nombre:
```
### Variables
Some translations contain variables. They look like this:
```
Hi {{name}}, welcome back!
```
Variables should not be translated.
```
❌ Salut {{nom}}, bienvenue!
✅ Salut {{name}}, bienvenue!
```
### Tags
Some translations contain tags. They look like this:
```
Go to <a>page</a>
```
Tags are typically used to change the appearance of some text (ex. bold, italics etc…) or to create a hyperlink. Make sure the tags are not translated and they remain wrapped around the same piece of text.
```
❌ Gehen Sie zur Seite
<a>Gehen Sie zur Seite</a>
❌ Gehen Sie zur <ä>Seite</ä>
✅ Gehen Sie zur <a>Seite</a>
```
### Not sure? Ask…
Some translations can be tricky without any context. If you're not sure about something, please ask in the [discord chat](https://discord.gg/m5UFXavc2C).