rust/comprehensive-rust
1
0
Fork 0
mirror of https://github.com/google/comprehensive-rust.git synced 2025-05-14 22:56:44 +02:00
Code Issues Releases Activity

Give guidance on how to review translations (#784)

Browse Source 
This captures some general advice which I’ve been handing out 1:1 to
the many new translation reviewers.
This commit is contained in:
Martin Geisler 2023-06-08 16:42:09 +02:00 committed by GitHub
parent 806dbca402
commit 753dea4950
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 32 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
TRANSLATIONS.md
View File

@ -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