Merge pull request #62 from benjiwheeler/pull-request-template

added pull request template, and note on where to find react-intl info

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,53 @@
+### Resolves
+
+- Resolves #
+
+### Proposed Changes
+
+_Describe what this Pull Request does_
+
+## Checklist for updating translations
+
+There are two situations in which we create manual PRs to update translations:
+
+1. We don't want to wait for Travis's automatic weekly update; or,
+2. We need to add a language that has become ready
+
+### 1. Updating translations manually
+
+* [ ] Pull translations from Transifex with `> npm run pull:editor`
+* [ ] Test the result with `> npm run test`
+* [ ] Confirm that you see changes to files like `editor/<resource>/<lang code>.json`
+
+### Adding a language
+
+* [ ] Edit `src/supported-locales.js`:
+  * [ ] Add entry for the language in the `locales` const
+  * [ ] Check if language is right-to-left. If so:
+    * Add entry in `rtlLocales`
+
+* [ ] Check if language needs a new locale (such as Brasilian Portuguese). If so:
+  * [ ] Edit `src/supported-locales.js`:
+    * Add new entry to `localeMap`. Format is `'<browser locale string>': '<Transifex locale string/ISO standard>'`
+  * [ ] Edit `.tx/config`:
+    * Add to the `lang_map` list. Format is `<Transifex locale string/ISO standard>:<browser locale string>`
+    * NOTE: we are moving away from using the `tx` cli; `.tx/config` will eventually be deprecated
+
+* [ ] Edit `src/index.js`:
+  * [ ] Add 'import' line and export line
+  * [ ] Add entry in `localeData` array
+
+* [ ] check if locale is in `react-intl`
+  * Look in [https://unpkg.com/react-intl/locale-data/](https://unpkg.com/react-intl/locale-data/)
+  * If not in `react-intl`:
+    * [ ] Edit `src/supported-locales.js`:
+      * In `customLocales`, add entry with parent set to a `react-intl` locale
+    * [ ] Edit `src/index.js`:
+      * In `localeData`, add entry for parent locale
+
+* [ ] update translations per the "Updating translations" section above
+* [ ] Confirm that we see changes to:
+    * [ ] `src/supported-locales.js`
+    * [ ] `src/index.js`
+    * [ ] `.tx/config` (if language needed a new locale)
+    * [ ] Multiple files like `editor/<resource>/<lang code>.json`

README.md

@@ -30,3 +30,7 @@ scratch-l10n provides:
 scratch-l10n uses semantic versioning - breaking changes will increment the major version number, and new features (e.g. a new language) will increment the minor version number. However, the patch number is actually a datetime string. That way it's easy to see how recently the translations were updated.
 
 In general, changes that require a PR (new functionality, new language) should increment the minor version. Pulling new translations from Transifex is automated and will commit to master directly.
+
+#### Deprecations
+
+We are moving away from using the `tx` cli, so the `.tx/config` file will eventually be deprecated.

src/index.js

@@ -1,3 +1,6 @@
+// to find locale data in react-intl, go to:
+// https://unpkg.com/react-intl/locale-data/
+
 import en from 'react-intl/locale-data/en';
 import am from 'react-intl/locale-data/am';
 import ar from 'react-intl/locale-data/ar';