1
0
mirror of https://github.com/bitwarden/browser.git synced 2024-11-24 12:06:15 +01:00

Added constributing file. Contributing guidelines for i18n.

This commit is contained in:
Kyle Spearrin 2016-11-25 23:16:24 -05:00
parent b107196dcc
commit 4731d59b40
2 changed files with 22 additions and 1 deletions

20
CONTRIBUTING.md Normal file
View File

@ -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: <https://developer.chrome.com/webstore/i18n?csw=1#localeTable>. 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: <https://github.com/bitwarden/browser/pull/49/files>

View File

@ -10,6 +10,7 @@ The bitwarden browser extension is written using the Chrome Web Extension API an
# Contribute # 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. Security audits and feedback are welcome. Please open an issue or email us privately if the report is sensitive in nature.