From 29cf936735c74a8981f8508c91f981f3c0a697ba Mon Sep 17 00:00:00 2001 From: Baoyuan Date: Fri, 30 Jul 2021 10:10:04 -0500 Subject: feat: add Language contribution guide in README (#120) * fix: unmatched title * feat: add Language contribution guide * fix: update README * Update README.md Co-authored-by: Ben Woodward * Update README.md Co-authored-by: Ben Woodward Co-authored-by: Ben Woodward --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index bbeeda1..039b295 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,15 @@ make run This project uses [Prettier](https://prettier.io/) formatting. All pull requests must pass the automated lint checks before merging. Prettier format is run automatically as a pre-commit hook. +## Language Contribution Guide + +We would love for you to contribute to different languages and help make it even better than it is today! As a language contributor, here are some steps we would like you to follow: + +1. Add a translation to [`./src/i18n.js`](./src/i18n.js) +2. Add the language option to [`./src/App.js`](./src/App.js) in the format `latinName - nativeName`, e.g. `French - Français` +3. If the languages added require RTL direction, add the language keys to RTL_LANGUAGES constant in ./src/App.js. +4. Add an entry to the translation-table in README.md. + ## Supported Languages | Language | Author Credit | -- cgit v1.2.3