Giter VIP home page Giter VIP logo

protondb-i18n's Introduction

protondb-i18n

A crowdsourced journey to translate ProtonDB (News post)

Overview

ProtonDB loads its text using react-i18next (version 10) resource bundles in JSON.

Each language, as represented by their 'xx-XX' BCP-47 language tag, lives within locales. Within each locale's directory are two files:

  • contribute.json (translations for the reporting flow)
  • translation.json (everything else)

Prerequisites

None! You can browse this repository and edit the files manually. But editing language files can be fiddly and typos are common. It's preferable to grab some tools:

  • Node.js
  • yarn (if you want to skip this, npm is included with node and will probably work fine as a substitute).
  • A text editor, ideally one with colored formatting for JSON.

Contributing

All native speakers are welcome to contribute! Please do not make pull requests with automated translations.

  • Fork this repo
  • Download your fork
  • In your downloaded directory, run yarn install
  • If starting a new locale, create the directory named after your language tag within locales and copy over files from the locales/en-US directory
  • Make your changes/additions
  • Review them visually (see Verify Your Changes below)
  • Run yarn lint:json to validate everything is alphabetized and formatted properly
  • Commit, push, and open a pull request!

Any questions? Ask us on Discord

Verify Your Changes

Keep an eye out for page rendering issues if your text is smaller or larger than the English equivalent, and open an issue with a screenshot if you cannot fit readable words for your language.

  • Learn how to modify your browser's local storage (here are instructions for Chrome and Firefox)
  • Visit ProtonDB
  • If you're not already, switch to English
  • Copy the contents of your contribute.json file into a local storage entry as i18next:en-US-contribute
  • Copy the contents of your translation.json file into a local storage entry as i18next:en-US-translation
  • Reload and review

Known Active Translators

Maybe you?

Hall of Fame

Coming soon

  • An expanded ProtonDB help section will need translations too!

protondb-i18n's People

Contributors

bdefore avatar noxphasma avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.