diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f38525c9..d6ef1fb1 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -27,10 +27,11 @@ There are two situations in which we create manual PRs to update translations: * Add entry in `rtlLocales` * [ ] Check if language needs a new locale (such as Brasilian Portuguese). If so: - * [ ] Edit `.tx/config`: - * Add to the `lang_map` list. Format is `:` * [ ] Edit `src/supported-locales.js`: * Add new entry to `localeMap`. Format is `'': ''` + * [ ] Edit `.tx/config`: + * Add to the `lang_map` list. Format is `:` + * 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 diff --git a/README.md b/README.md index 646f5181..bbbb93a9 100644 --- a/README.md +++ b/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.