Skip to content

Latest commit

 

History

History
21 lines (18 loc) · 1.78 KB

how-to-add-a-language.md

File metadata and controls

21 lines (18 loc) · 1.78 KB
Raw

How to add a language

English version by Peter Wone

  1. Open the vscode-print repo.
  2. Log in to GitHub.
  3. Fork the repo and clone your fork to your workstation.
  4. In the root of the repo there is a folder i18n. It contains one child folder for each supported language. The naming scheme is ISO639-3 and this is not negotiable. Look up the three letter code for your language using this website.
  5. Create a folder with this name (eng for English, fra for French etc) as an immediate child of the i18n folder.
  6. Copy the file packagei18n.json from the /i18n/eng folder to the folder you just created for your language.
  7. Use a UTF8 capable editor (VS Code is a good choice) to edit this file.
  8. Replace each English string with your translation.
    • Translation of jargon and technical terms is tricky but you are a subject matter expert, so ask yourself: What would I see in my source code? How would I write this in email to another programmer?
    • DO NOT translate the keys (the property names).
  9. Translate README.md and manual.md to README.xyz.md and manual.xyz.md where xyz is your language code.
  10. There's probably no point translating this file unless you seriously expect translation from your language to another.
  11. Save, stage, commit and push your changes to your fork on GitHub.
  12. Raise a PR to tell me to merge your updates into the next release.
  13. Register your language in gulpfile.js so it will be built

I encourage you to credit yourself for translation in a by-line at the start of each document under the main heading. It is possible to make your name a mail link but there is no need since people can use your fork to raise issues.