~aleteoryx/muditaos

72198cdcfb3a70af61919b70b1980bebe9f26042 — Wojtek Cichoń 5 years ago 54cde51
[EGD 4142] Creating i18n article (#902)

* Added first draft of i18n article
2 files changed, 18 insertions(+), 0 deletions(-)

M CONTRIBUTING.md
A doc/i18n.md
M CONTRIBUTING.md => CONTRIBUTING.md +2 -0
@@ 34,3 34,5 @@ If you have an idea for a feature that could possibly land in MuditaOS please le
If you would like to contribute a new feature or a bug fix to MuditaOS, please discuss your idea first in Github issues. If there is no Github issue for your idea, please open one. It may be that somebody from Mudita core team is already working on it, or that there are particular complexities that you should know about before starting the implementation.

Please refer to the [Development workflow article](#./doc/development_workflow.md) to learn how to submit code and documentation changes to the MuditaOS repository.

If you want to start localizing MuditaOS interface please start from [the "Internationalization" article](./doc/i18n.md).

A doc/i18n.md => doc/i18n.md +16 -0
@@ 0,0 1,16 @@
# Internationalization

## File and data structure

Currently all the wording used in MuditaOS interface is collected in the form of JSON files which are located in [the Image Assets folder](../image/assets/lang/).

The default fallback file for every language is currently the English version - `lang_en.json`

MuditaOS follows [Linux `date`](https://man7.org/linux/man-pages/man1/date.1.html) to format date and time. 

## How to start localizing the interface

1. Create an issue with the localization you want to start working on. Please use the following scheme: `[Language] localization [emoji_flag]` eg. `Polish localization 🇵🇱`. The emoji flag is a small detail that can help other community members in finding the localization they're interested in and helping you out in implementing it. Please make sure that the localization you want to implement has not been already implemented.
2. Add a `i18n` label to your new issue on GitHub.
3. Follow [the "Contributing to MuditaOS" article](../CONTRIBUTING.md).
4. As soon as you create a Pull Request with your localization we will review it and add it to the official MuditaOS distribution.