Skip to content

Contributing a Language

Elijah R edited this page Apr 9, 2024 · 4 revisions

Contributing your Language

Computernewb is looking for anyone willing to translate CollabVM into their language. To do so, please follow the instructions below!

  1. Switch to the code section and click "Fork" to create your own fork of this repository.
  2. In your fork's source tree, head to /static/lang/ and open en-us.json. Copy the entire file.
  3. Create a new file at /static/lang/<language>-<country>.json (use the Add File button if you use the github web UI), where <language> and <country> are both ISO country and language codes. For example: de-de.json
  4. Paste the content of en-us.json and start editing!
    • For the top four fields, you'll want to fill the following:
      • languageName: The name of your language, in your language (e.g. "Deutsch")
      • translatedLanguageName: The name of your language, in English (e.g. "German")
      • flag: Paste the emoji for your country's flag directly into this field (e.g. "🇩🇪")
      • author: Your name/username
    • Then, translate each line in stringKeys into your language.
  5. Commit the language file to your fork
  6. Open /static/lang/languages.json in your editor, and add your language to the end of languages. For example, it could become "languages": ["en-us", "de-de"],
  7. Head to https://github.com/computernewb/collab-vm-1.2-webapp/compare and open a pull request from your fork! You can title it something simple like "Add German"
  8. We'll review your PR and merge your language into the repo

Clone this wiki locally