From 753dea4950e062fa064681a78bbf69e0ffd368fd Mon Sep 17 00:00:00 2001 From: Martin Geisler Date: Thu, 8 Jun 2023 16:42:09 +0200 Subject: [PATCH] Give guidance on how to review translations (#784) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This captures some general advice which I’ve been handing out 1:1 to the many new translation reviewers. --- TRANSLATIONS.md | 35 ++++++++++++++++++++++++++++++++--- 1 file changed, 32 insertions(+), 3 deletions(-) diff --git a/TRANSLATIONS.md b/TRANSLATIONS.md index ddaa8ed1..c4f82a3b 100644 --- a/TRANSLATIONS.md +++ b/TRANSLATIONS.md @@ -1,9 +1,13 @@ # Translations of Comprehensive Rust 🦀 We would love to have your help with translating the course into other -languages! We use the [Gettext] system for translations. This means that you -don't modify the Markdown files directly: instead you modify `.po` files in a -`po/` directory. The `.po` files are small text-based translation databases. +languages! Please see the [translations page] for the existing translations.. + +[translations page]: https://google.github.io/comprehensive-rust/running-the-course/translations.html + +We use the [Gettext] system for translations. This means that you don't modify +the Markdown files directly: instead you modify `.po` files in a `po/` +directory. The `.po` files are small text-based translation databases. > **Tip:** You should not edit the `.po` files by hand. Instead use a PO editor, > such as [Poedit](https://poedit.net/). There are also several online editors @@ -134,3 +138,28 @@ $ MDBOOK_BOOK__LANGUAGE=xx mdbook serve -d book/xx When you update the `po/xx.po` file, the translated book will automatically reload. + +## Reviewing Translations + +When a new translation is started, we look for people who can help review it. +These reviewers are often Googlers, but they don't have to be. To automatically +get an email when new PRs are created for your language, please add yourself to +the [CODEOWNERS] file. + +When reviewing a translation, please keep in mind that translations are a labour +of love. Someone spends their free time translating the course because they want +to bring Rust to users who speak their language. + +Nothing is published right away after a PR lands for a new in-progress language. +It is therefore safe to merge the PR as long as the translation is reasonable. +This is often better than leaving 50+ comments since this can be overwhelming +for the contributor. Instead, please work with the contributor to improve things +in follow-up PRs. + +### Incomplete Translations + +When the first 1-2 days of the course have been translated, we can publish the +translation and link it from the [translations page]. The idea is to celebrate +the hard work, even if it is incomplete. + +[CODEOWNERS]: https://github.com/google/comprehensive-rust/blob/main/.github/CODEOWNERS