From 25bf0b471f508066eb8a111061412e1c7ab3f520 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jaime=20Guti=C3=A9rrez=20Alfaro?= <593829+jamescr@users.noreply.github.com> Date: Sun, 18 Jul 2021 19:26:06 -0600 Subject: [PATCH] Update CONTRIBUTING.md Add steps on how to contribute with translations. --- CONTRIBUTING.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8acbc3a..c95d2c6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,5 @@ -## Contributing +# Contributing Everyone can contribute to the development of the app, and that's great!. Since we'll be using [gitflow](https://datasift.github.io/gitflow/IntroducingGitFlow.html), it's recommended to have feature branches that will eventually be merged back to the `develop` via pull requests, and later `develop` will be merged back to master when we're ready for a new release. ## How to run the app @@ -24,3 +24,10 @@ It's recommended to run the tests locally before making a new pull request to ma - For running the **unit tests** no emulator or device is needed, just run - `$ ./gradlew test` - Now just wait for gradle to run the tests for you, it'll show the results of which tests passed or failed when it's finished + +## Translations +OSMTracker is translated using Transifex (see the [wiki](https://github.com/labexp/osmtracker-android/wiki/Translating)). +To update translations: +* Create a python3 virtual environment: `$python3 -m venv .venv` (.venv folder is already added to gitignore file). Remember the virtualenv activates with the command `$source .venv/bin/activate` and deactivates with `deactivate`. +* Install Transifex CLI Client following the instructions in [this page](https://docs.transifex.com/client/installing-the-client#installing-on-macos-and-linux). +* Execute `(.venv) $ tx pull --minimum-perc 1` to get the updated translations with at least 1% of completeness.