added notes about .tx/config deprecation

This commit is contained in:
Ben Wheeler 2019-01-22 09:51:45 -05:00
parent 4c9541b47d
commit bb7b458a85
2 changed files with 7 additions and 2 deletions

View file

@ -27,10 +27,11 @@ There are two situations in which we create manual PRs to update translations:
* Add entry in `rtlLocales` * Add entry in `rtlLocales`
* [ ] Check if language needs a new locale (such as Brasilian Portuguese). If so: * [ ] Check if language needs a new locale (such as Brasilian Portuguese). If so:
* [ ] Edit `.tx/config`:
* Add to the `lang_map` list. Format is `<Transifex locale string/ISO standard>:<browser locale string>`
* [ ] Edit `src/supported-locales.js`: * [ ] Edit `src/supported-locales.js`:
* Add new entry to `localeMap`. Format is `'<browser locale string>': '<Transifex locale string/ISO standard>'` * 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`: * [ ] Edit `src/index.js`:
* [ ] Add 'import' line and export line * [ ] Add 'import' line and export line

View file

@ -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. 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. 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.