From 045ccaa2199953e163c9599da2e42d75262d08b5 Mon Sep 17 00:00:00 2001 From: Kyle Spearrin Date: Thu, 29 Dec 2016 00:26:14 -0500 Subject: [PATCH] readme updates --- CONTRIBUTING.md | 28 ++++++++++++++++++++++++++++ README.md | 1 + 2 files changed, 29 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..55789d4db --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,28 @@ +Code contributions are welcome! Please commit any pull requests against the `master` branch. + +# Internationalization (i18n) + +If you are interested in helping translate the bitwarden mobile app into another language, please follow these steps +when creating your pull request: + +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. 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 inable 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/blob/master/src/App/Resources/AppResources.resx) + to the `/src/App/Resources/AppResources.resx` file so that your translation will stay up to date. + +You can find an example of a proper translation pull request here: diff --git a/README.md b/README.md index 94d80d3c5..079237a9f 100644 --- a/README.md +++ b/README.md @@ -10,5 +10,6 @@ The bitwarden mobile application is written in C# with Xamarin Android, Xamarin # Contribute Code contributions are welcome! Visual Studio or Xamarin Studio is required to work on this project. 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.