Help translate the README: four languages open, and yours if it is not listed #598
cevheri
announced in
Announcements
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
LibreDB Studio's README exists in English, Chinese and Japanese. We would like more, and this is a good first contribution if you read and write the language well.
It is smaller than it looks
README.mdis 994 lines.README_zh.mdandREADME_ja.mdare 304 and 291. The translations are deliberate abridgements: the pitch, the engine list, the install table, the quick start. The deep sections are not translated at all. Copy that scope rather than translating the whole file.A required check decides half the review for you
scripts/readme-check.mjsruns inside the requiredLint, Typecheck and Buildjob and asserts two things about every localized README:README.md's. A translation may not omit an engine or invent one, and engine names stay in English -PostgreSQLstaysPostgreSQL.README.md's. You may list fewer channels (both existing translations drop Chocolatey and the portable zip), but you may not paraphrase a command. A droppedsudoor a missingbrew trustis exactly what this guard was written for.Run
bun run readme:checkbefore you push. What the guard cannot judge is whether the prose reads well in your language - that part is yours.Open now, one issue per language
Your language is not listed?
Reply here with the language and we will open an issue for it and assign it to you. There is no fixed list - those four were a starting guess, not a ranking. Vietnamese, French, Arabic, Russian, German, Urdu, Indonesian and Persian would all be welcome, and so would one nobody has named yet.
Two asks
Take a language you actually read and write. Raw machine-translation output is not what this is for, and a PR that reads as untouched machine output will be closed. Technical terms and product names are better left in English than translated approximately.
Claim before you start, here or on the issue, so two people do not translate the same file.
Each language is one new file plus one line in the language switcher of every existing README, so the only thing two translations can conflict on is that one line. Rebasing it takes a minute.
All reactions