Browse Source

docs: Add translations section to contributing.md

Ased Mammad 1 year ago
parent
commit
df8aeb39c6
1 changed files with 10 additions and 0 deletions
  1. 10 0
      docs/CONTRIBUTING.md

+ 10 - 0
docs/CONTRIBUTING.md

@@ -50,6 +50,16 @@ We welcome pull requests. Before submitting one, please:
 
 Help us make Open WebUI more accessible by improving documentation, writing tutorials, or creating guides on setting up and optimizing the web UI.
 
+### 🌐 Translations and Internationalization
+
+Help us make Open WebUI available to a wider audience. In this section, we'll guide you through the process of adding new translations to the project.
+
+We use JSON files to store translations. You can find the existing translation files in the `src/lib/i18n/locales` directory. Each directory corresponds to a specific language, for example, `en` for English, `fr` for French and so on. You can refer to [ISO 639 Language Codes][https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes] to find the appropriate code for a specific language.
+
+To add a new language:
+- Create a new directory in the `src/lib/i18n/locales` path with the appropriate language code as its name. For instance, if you're adding translations for Spanish, create a new directory named `es`.
+- Copy the English translation file(s) (from `en` directory in `src/lib/i18n/locale`) to this new directory and update the string values in JSON format according to your language. Make sure to preserve the structure of the JSON object.
+
 ### 🤔 Questions & Feedback
 
 Got questions or feedback? Join our [Discord community](https://discord.gg/5rJgQTnV4s) or open an issue. We're here to help!