From 9352f2566cda63ad9ec1ec159f1ae7b836acbbef Mon Sep 17 00:00:00 2001
From: 0ko <0ko@noreply.codeberg.org>
Date: Tue, 17 Dec 2024 13:43:54 +0000
Subject: [PATCH] chore(i18n): add readme (#6296)

Give documentation more visibility. I hope it will.

Also document attribution because the TRANSLATORS file is probably confusing.

Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/6296
Reviewed-by: Antonin Delpeuch <wetneb@noreply.codeberg.org>
Reviewed-by: Otto <otto@codeberg.org>
---
 options/locale/readme.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 options/locale/readme.md

diff --git a/options/locale/readme.md b/options/locale/readme.md
new file mode 100644
index 0000000000..f6f198a936
--- /dev/null
+++ b/options/locale/readme.md
@@ -0,0 +1,26 @@
+# Forgejo translations
+
+This directory contains all .INI translations.
+
+## Working on base language
+
+When you work on Forgejo features, you should only modify `locale_en-US.ini`.
+
+* consult https://forgejo.org/docs/next/contributor/localization-english/
+* add strings when your change requires doing so
+* remove strings when your change renders them unused
+
+## Working on other languages
+
+Translations are done on Codeberg Translate and not via individual pull requests.
+
+* consult https://forgejo.org/docs/next/contributor/localization/
+* see the project: https://translate.codeberg.org/projects/forgejo/forgejo/
+
+## Attribution
+
+Forgejo translators are attributed in commit messages and in monthly updates on the website.
+
+Gitea translators are mostly not attributed in this repository because Gitea translation commits are lacking attribution, but it may be preserved on Crowdin.
+
+This directory contains a legacy `TRANSLATORS` file from the Gogs era. It is opt-in and is not actively maintained.