From 43698b23c64333e73833d597d076f3f502a5236e Mon Sep 17 00:00:00 2001
From: Frank Elsinga <frank@elsinga.de>
Date: Wed, 2 Aug 2023 11:30:54 +0200
Subject: [PATCH] Chore: Updated translation contributing guide (#3511)

* made the translation part of the contribution guide/Readme more clear

* made some formatting adjustments and added a few links

* fixed a typo

* Apply suggestions from code review

* Added DBeaver
---
 CONTRIBUTING.md | 32 +++++++++++++++++++++-----------
 README.md       |  5 ++++-
 2 files changed, 25 insertions(+), 12 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a933a4508..30a355dbf 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -34,19 +34,19 @@ Yes or no, it depends on what you will try to do. Since I don't want to waste yo
 
 Here are some references:
 
-✅ Usually Accept:
+### ✅ Usually accepted:
 - Bug fix
 - Security fix
 - Adding notification providers
-- Adding new language files (You should go to https://weblate.kuma.pet for existing languages)
+- Adding new language files (see [these instructions](https://github.com/louislam/uptime-kuma/blob/master/src/lang/README.md))
 - Adding new language keys: `$t("...")`
 
-⚠️ Discussion First
+### ⚠️ Discussion required:
 - Large pull requests
 - New features
 
-❌ Won't Merge
-- A dedicated pr for translating existing languages (You can now translate on https://weblate.kuma.pet) 
+### ❌ Won't be merged:
+- A dedicated pr for translating existing languages (see [these instructions](https://github.com/louislam/uptime-kuma/blob/master/src/lang/README.md))
 - Do not pass the auto test
 - Any breaking changes
 - Duplicated pull requests
@@ -106,11 +106,11 @@ I personally do not like something that requires so many configurations before y
 
 ## Tools
 
-- Node.js >= 14
-- NPM >= 8.5
-- Git
-- IDE that supports ESLint and EditorConfig (I am using IntelliJ IDEA)
-- A SQLite GUI tool (SQLite Expert Personal is suggested)
+- [`Node.js`](https://nodejs.org/) >= 14
+- [`npm`](https://www.npmjs.com/) >= 8.5
+- [`git`](https://git-scm.com/)
+- IDE that supports [`ESLint`](https://eslint.org/) and EditorConfig (I am using [`IntelliJ IDEA`](https://www.jetbrains.com/idea/))
+- A SQLite GUI tool (f.ex. [`SQLite Expert Personal`](https://www.sqliteexpert.com/download.html) or [`DBeaver Communtiy`](https://dbeaver.io/download/))
 
 ## Install Dependencies for Development
 
@@ -218,7 +218,17 @@ If for maybe security reasons, a library must be updated. Then you must need to
 
 ## Translations
 
-Please read: https://github.com/louislam/uptime-kuma/tree/master/src/languages
+Please add **all** the strings which are translatable to `src/lang/en.json` (If translation keys are ommited, they can not be translated).
+
+**Don't include any other languages in your inital Pull-Request** (even if this is your mother tounge), to avoid merge-conflicts between weblate and `master`.  
+The translations can then (after merging a PR into `master`) be translated by awesome people donating their language-skills.
+
+If you want to help by translating Uptime Kuma into your language, please visit the [instructions on how to translate using weblate](https://github.com/louislam/uptime-kuma/blob/master/src/lang/README.md).
+
+## Spelling & Grammar
+
+Feel free to correct the grammar in the documentation or code.
+My mother language is not english and my grammar is not that great.
 
 ## Wiki
 
diff --git a/README.md b/README.md
index c089cd41f..151e9a6e0 100644
--- a/README.md
+++ b/README.md
@@ -184,7 +184,10 @@ If you want to report a bug or request a new feature, feel free to open a [new i
 ### Translations
 If you want to translate Uptime Kuma into your language, please visit [Weblate Readme](https://github.com/louislam/uptime-kuma/blob/master/src/lang/README.md).
 
-Feel free to correct my grammar in this README, source code, or wiki, as my mother language is not English and my grammar is not that great.
+## Spelling & Grammar
+
+Feel free to correct the grammar in the documentation or code.
+My mother language is not english and my grammar is not that great.
 
 ### Create Pull Requests
 If you want to modify Uptime Kuma, please read this guide and follow the rules here: https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md