diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d1588a81a..99497c9d9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,33 +1,11 @@ Code contributions are welcome! Please commit any pull requests against the `master` branch. -# Internationalization (i18n) +# Localization (l10n) -If you are interested in helping translate the bitwarden mobile app into another language, please follow these steps -when creating your pull request: +We use a translation tool called [Crowdin](https://crowdin.com) to help manage our localization efforts across many different languages. -1. Create a new resource file under `/src/App/Resources` by copy/pasting the master English file, `AppResources.resx`. -2. Rename your `AppResources.resx` copy to include the proper .NET culture code for your language (typically the two - letter code, ex. `sv`). You can find a list of culture codes here: . For - example, if I want to create a new translation for Swedish, I will rename my `AppResources.resx` copy to - `AppResources.sv.resx`. -3. Open the `AppResources.XX.resx` file for your newly created language and start translating the `` tags for - each `` element. The `` and `` properties should not be translated and remain in English. -4. Repeat the same process for the store `COPY.md` and `CAPTIONS.md` files in `/store/apple` and `/store/google` by - creating a new folder for your language in each. Do not copy over the `assets` and `screenshots` folders to your new - language. We will update these based on your translations provided in `CAPTIONS.md`. Finally, do not translate the - titles in the markdown files (ex. `# Name` and `# Screenshot 1`). These are only for reference. -5. If you have a Xamarin development environment setup, test your translations to make sure they look correct in the - app on iOS and Android. Sometimes the UI can break due to translations taking up more space than the original UI was - built for. If possible, use a shorter or abbreviated version of the word/sentence to accomedate the available space. - If you are unable to accomedate the avaialable space for a particular translation, just let us know in your pull - request comments. If you are unable to test your translations, just let us know in your pull request comments so - that we can check it for you. -6. Be sure to watch for [future changes](https://github.com/bitwarden/mobile/commits/master/src/App/Resources/AppResources.resx) - to the `/src/App/Resources/AppResources.resx` file so that your translation will stay up to date. +If you are interested in helping translate the bitwarden mobile app into another language (or make a translation correction), please register an account at Crowdin and join our project here: https://crowdin.com/project/bitwarden-mobile -You can find an example of a proper translation pull request here: +If the language that you are interested in translating is not already listed, create a new account on Crowdin, join the project, and contact the project owner (https://crowdin.com/mail/compose/kspearrin). -You can read more about localizing a Xamarin.Forms app here: - - -TIP: If you have Visual Studio installed, it provides a nice tabular UI for editing `resx` XML files. +You can read Crowdin's getting started guide for translators here: https://support.crowdin.com/crowdin-intro/