From 4731d59b40e03a0d18586e1079016fbde29fd31b Mon Sep 17 00:00:00 2001 From: Kyle Spearrin Date: Fri, 25 Nov 2016 23:16:24 -0500 Subject: [PATCH] Added constributing file. Contributing guidelines for i18n. --- CONTRIBUTING.md | 20 ++++++++++++++++++++ README.md | 3 ++- 2 files changed, 22 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..39b9ee4840 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,20 @@ +Code contributions are welcome! Please commit any pull requests against the `master` branch. + +# Internationalization (i18n) + +If you are interested in helping translate the bitwarden browser extension into another language, please follow these steps +when creating your pull request: + +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. + +You can find an example of a proper translation pull request here: diff --git a/README.md b/README.md index 61bc806c13..bb0290e8f6 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ The bitwarden browser extension is written using the Chrome Web Extension API an # Contribute -Code contributions are welcome! Please commit any pull requests against the `master` branch. +Code contributions are welcome! Please commit any pull requests against the `master` branch. Learn more about how to contribute +by reading the [`CONTRIBUTING.md`](CONTRIBUTING.md) file. Security audits and feedback are welcome. Please open an issue or email us privately if the report is sensitive in nature.