Translate the README into more languages

Open Beginner friendly
  • Is something wrong?
#161 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
markdown
Domain
documentation, internationalization, localization

Research direction

Start with README.md, an existing translation such as README.es.md, and the “Translating the README” section of CONTRIBUTING.md. Copy a translation, preserve the specified code and formatting elements, add the language navigation and links to every README, and register it in TRANSLATIONS in scripts/check-readme-i18n. Run scripts/check-readme-i18n and confirm the readme-i18n CI job passes.

Written by the indexing model from the issue text.

Description

documentation enhancement good first issue help wanted needs-triage ready-for-human

The root README is published in English, Spanish, French, German and
Brazilian Portuguese (see #160). Readers outside those languages only get
the English original.

What is wanted

Translations of README.md into additional languages, contributed by people
fluent in the language. There is no fixed list: if you are fluent in a
language we do not cover yet, it is wanted. Widely spoken developer
languages such as Italian, Dutch, Polish, Ukrainian, Japanese, Korean and
Simplified Chinese are obvious gaps, but any language is welcome.

To avoid duplicate work, comment on this issue to claim a language before
starting, and keep to one language per pull request. Reviews of the four
existing translations by fluent speakers are welcome too.

How to contribute

Copy an existing translation (for example README.es.md) to
README.<code>.md and follow the process in CONTRIBUTING.md
("Translating the README"):

  • Translate prose only. Fenced code blocks, commands, identifiers, URLs,
    link destinations, inline code, heading levels, tables and admonition
    markers must stay byte-identical to the English file.
  • Keep the language nav bar at the top, link the new file from every
    README, and register it in TRANSLATIONS in
    scripts/check-readme-i18n.
  • Run scripts/check-readme-i18n before opening the pull request; it and
    the readme-i18n CI job must pass.

English (README.md) stays authoritative and wins on any discrepancy.

Dominant language
Rust
Stars
31
Forks
42
Avg merge
3d 21m
Merged PRs (30d)
147

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from getsotto/sotto

All issues in getsotto/sotto

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.