Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Translation guide #87

Merged
merged 5 commits into from
Oct 19, 2021
Merged

Translation guide #87

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1fd956d
Translation guide
ferrix Oct 16, 2021
0a82ed9
Typo fix
ferrix Oct 16, 2021
541914c
Update TRANSLATING.md
ferrix Oct 16, 2021
0476bd4
Update TRANSLATING.md
ferrix Oct 16, 2021
17c0c60
Update TRANSLATING.md
ferrix Oct 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions TRANSLATING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Guide for translators of the Minimum Viable CD

In case you want to translate this manifest, follow these guidelines:

0. Translating the full text of the manifest itself is the minimum viable translation. The FAQ is subject to change more frequently and is optional to translate as long as the links then point to the English version. The list of resources is not going to be maintained in several languages.
ferrix marked this conversation as resolved.
Show resolved Hide resolved
1. Use common language easily understood by a student of software engineering or a stakeholder working with engineers.
2. If the terms have been translated to the target language before, prefer them over mixing with English and the target language.
3. Replace the bottom of the front page starting from the Signatories with the translated version of this page starting from under the horizontal rule.
4. Update the commit hash and timestamp to the "Translation" subsection. This should make version drift between languages apparent to the reader.
5. Get a peer review side by side from someone who reads both languages fluently and is preferably a native user of the target language.
6. If viable, get a peer review of the translated text from someone who has not read the English text for clarity.
7. Translating the quote from Accelerate is optional if the book has not been translated into the target language. If you translate it yourself, mark it with `(Unofficial translation)`
8. All translations must be stored under a directory named with the ISO 639-1 language code and the file names the same as the originals (even though FAQ does not mean anything in most languages). Example: se/README.md and se/FAQ.md for Northern Sami.
9. Send a pull request that updates the list of translations for navigation. (at the time of writing this document, no such thing exists and will be sorted out then)

---

## Signatories

The signatories have signed the [original English version](/#signatories) and the current list of names is published only with that version.

## Translation

This translation is a community effort in order to help pass this information beyond language barriers. The signatories themselves cannot confirm the correctness of the translation.

Translated from document version: _commitish_, _ISO date_