Skip to content

Commit fb09c58

Browse files
committed
docs: improve Running Tests and Translations sections in CONTRIBUTING.md
1 parent 4f409f8 commit fb09c58

1 file changed

Lines changed: 14 additions & 16 deletions

File tree

CONTRIBUTING.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -38,29 +38,27 @@ cd osmtracker-android
3838
3. Build the project (`Ctrl + F9` or the 🛠️ hammer button)
3939

4040

41-
4241
## 🧪 3. Running Tests
4342

44-
This repository has an automated way to run the tests on branches but if you already have the project installed on you computer then you can also run them from a terminal.
45-
It's recommended to run the tests locally before making a new pull request to make sure the changes doesn't break any previous functionality. You can run the tests locally as follows:
46-
- Make sure you are at the *root directory of the project*
47-
- `$ cd YOUR_PATH/osmtracker-android`
43+
This repository has automated tests that run on CI for every branch, but it's highly recommended to run them locally before submitting a pull request to ensure your changes don't break existing functionality.
4844

49-
### 📱 Instrumentation Tests (Require Emulator or Device)
50-
- For running **instrumentation** tests it's needed to previously start up an emulator (or real device), you can do it from Android Studio but also without it using the command line. For that, you need to move to the Android SDK installation directory and look for a folder called `emulator` once there, start any already created emulator by typing:
51-
- `$ ./emulator -avd NAME` to start the emulator called *NAME* (run `$ ./emulator -list-avds` for a valid list of AVD names)
52-
- When it's up, go back to the root project folder and run the instrumentation tests with
53-
- `$ ./gradlew connectedAndroidTest`
45+
For **detailed instructions** covering unit tests, instrumented tests, coverage reports, and troubleshooting, please refer to:
5446

55-
### ✅ Unit Tests
56-
- For running the **unit tests** no emulator or device is needed, just run
57-
- `$ ./gradlew test`
58-
- 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
47+
👉 **[docs/TESTING.md](docs/TESTING.md)** 👈
5948

6049

6150
## 🌍 4. Translations
62-
OSMTracker is translated using Transifex (see the [wiki](https://github.com/labexp/osmtracker-android/wiki/Translating)).
63-
Once translations are complete, they will be updated via automated Transifex PR.
51+
52+
OSMTracker is translated using **[Transifex](https://www.transifex.com/)**, a localization platform that makes it easy for contributors to translate the app into their native language.
53+
54+
**How to help translate**
55+
56+
1. Go to the **[OSMTracker for Android™ project on Transifex](https://explore.transifex.com/labexp/osmtracker-android/)**
57+
2. Create a free Transifex account (if you don't have one)
58+
3. Select your language from the list
59+
4. Start translating strings
60+
61+
Once translations are complete on Transifex, they will be automatically synced to the repository via an automated Transifex Pull Request. This integration is configured using the [transifex.yml](transifex.yml) file in the repository root. For technical details about how the GitHub integration works, see the [Transifex GitHub Integration Guide](https://help.transifex.com/en/articles/6265125-github-installation-and-configuration).
6462

6563

6664
## 🧑‍💻 5. Git Workflow (GitFlow)

0 commit comments

Comments
 (0)