From a1b30c7fa8740fe611ffbde5b71b24a1beeade84 Mon Sep 17 00:00:00 2001 From: Seth Vargo Date: Wed, 2 Dec 2020 15:07:24 -0500 Subject: [PATCH] Add docs on how to i18n --- internal/i18n/README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 internal/i18n/README.md diff --git a/internal/i18n/README.md b/internal/i18n/README.md new file mode 100644 index 000000000..e951d886b --- /dev/null +++ b/internal/i18n/README.md @@ -0,0 +1,31 @@ +# Internationalization + +## New language + +To localize into a new language: + +1. Create a folder in `locales/` with the ISO 639-1 (preferred) or ISO 639-2 + code. + +1. Copy the canonical example from `locales/en/default.po`: + + ```text + cp locales/en/default.po locales//default.po + ``` + +1. Translate the `msgstr` values. Do **not** change other values in the file. + +1. Save the file and submit a pull request. + + +## Update an existing language + +To update an existing language: + +1. Find the language in the `locales/` folder. + +1. Update the `msgstr` fields to the new values. + +1. Save the file. + +1. Submit a pull request.