<aside> 🙌

This page is here to guide any contributor, internal or external, on how to translate the Caroster app, as well as its emails and notifications, into another language.

First of all, thank you very much for your time and commitment to the project. Translating Caroster into other languages helps make the project more accessible. We use Codeberg Translate, which is based on Weblate and designed for open-source projects like Caroster. Codeberg is a democratic, community-driven, and non-profit software development platform.

</aside>

Here’s the process for translating Caroster:

1. Access to the Translation tool:
   1. Go to the Caroster Project on Codeberg Translate.
   2. Create an account.
   3. In your settings, you can select your preferred interface language.
   4. Choose whether you want to translate the Caroster app (“Web app”) or the emails and notifications (“Notification emails”).
   5. The translated languages are displayed.
   6. The % shows the translation progress.
2. Translation:
   1. Click on the language you wish to translate, or click the plus button if translation for that language has not yet started.
   2. Click on “All strings.”
   3. Each item to be translated appears.
   4. At the top, you’ll see the item in the source language, English, and below it, the field to fill in the translation for the selected target language.
   5. Be careful not to change any greyed-out areas; you must copy-paste the code in the translation.
   6. Click “Save and continue” to translate item by item.
   7. You can then translate the emails and notifications or the app, depending on where you started.
3. Not sure about your translation:
   1. You can mark “Needs editing” if you’re unsure about your translation.
   2. You can view translations in other languages by clicking on “Other languages” if, for example, you’re more comfortable with another language than English.
4. End of the process:
   1. Once completed, we thank you greatly for translating Caroster!
   2. We have a double-checking system to validate translations.
   3. Once validated, the developers retrieve the generated translation file and integrate it into the code. The changes are then deployed on the Caroster test environment, tested, and approved for integration into the Caroster app.

<aside> 💡

We are not currently translating the Caroster website due to the significant costs involved for our organization. However, we are considering providing documentation in languages other than French or English.

</aside>

💞 Thank you for being part of the Caroster community and contributing to its continuous improvement!