From 4cef2975115da6a3fed29ef2a7edb69c586858c9 Mon Sep 17 00:00:00 2001 From: Emmanuel Alfaro Brenes Date: Thu, 20 Aug 2020 20:13:21 -0600 Subject: [PATCH 1/2] Add how to install the project and run tests to CONTRIBUTING.md --- CONTRIBUTING.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 948103eb1..21064eabf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1 +1,26 @@ + +## 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 +For running this project locally follow this steps: + - Clone the repository using git: + - `$ git clone https://github.com/labexp/osmtracker-android/` + - Install AndroidStudio + - [Here](https://developer.android.com/studio/install) is the official guide on how to install it on different operating systems + - Now open the IDE and click `open an existing Android Studio project`, then look for the folder where you cloned the repository + - Once it opens your project folder, click the top green hammer icon or press `Ctrl + F9` to make sure the project builds successfully + +## How to run the tests +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. +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: + - Make sure you at the *root directory of the project* + - `$ cd YOUR_PATH/osmtracker-android` + - 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: + - `$ ./emulator -avd NAME` to start the emulator called *NAME* + - When it's up, go back to the root project folder and run the instrumentation tests with + - `$ ./gradlew connectedAndroidTest` + + - 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 \ No newline at end of file From 2bb3244f294e593dd6dc65436600064611384bf2 Mon Sep 17 00:00:00 2001 From: EmmanuelAB Date: Fri, 21 Aug 2020 09:13:08 -0600 Subject: [PATCH 2/2] Add 'are' missing word --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 21064eabf..664a22a72 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,7 +14,7 @@ For running this project locally follow this steps: ## How to run the tests 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. 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: - - Make sure you at the *root directory of the project* + - Make sure you are at the *root directory of the project* - `$ cd YOUR_PATH/osmtracker-android` - 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: - `$ ./emulator -avd NAME` to start the emulator called *NAME* @@ -23,4 +23,4 @@ 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 \ No newline at end of file + - 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