diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 29a7a02e..2d36ff90 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,25 +1,13 @@ 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 browser extension into another language, please follow these steps -when creating your pull request: +[![Crowdin](https://d322cqt584bo4o.cloudfront.net/bitwarden-browser/localized.svg)](https://crowdin.com/project/bitwarden-browser) -1. Create a new folder under `/src/_locales` using the proper Chrome locale code. You can find the locales that Chrome - supports here: . For example, if I want to create a new - translation for German, I will create the folder `/src/_locales/de`. -2. Copy/paste the English `messages.json` file (`/src/_locales/en/messages.json`) into your newly created locales - folder. -3. Open the `messages.json` for your newly created locale and start translating the `message` JSON properties. The - `description` properties should be left in English as a reference. -4. Repeat the same process for the store `COPY.md` and `CAPTIONS.md` files in `/store`. Do not copy over the `assets` - and `screenshots` folders to your new locale. 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 - Sync`). - These are only for reference. -5. Test your translations to make sure they look correct in the extension. 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. -6. Be sure to watch for [future changes](https://github.com/bitwarden/browser/commits/master/src/_locales/en/messages.json) - to the `/src/_locales/en/messages.json` file so that your translation will stay up to date. +We use a translation tool called [Crowdin](https://crowdin.com) to help manage our localization efforts across many different languages. -You can find an example of a proper translation pull request here: +If you are interested in helping translate the bitwarden browser extension into another language (or make a translation correction), please register an account at Crowdin and join our project here: https://crowdin.com/project/bitwarden-browser + +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 Crowdin's getting started guide for translators here: https://support.crowdin.com/crowdin-intro/