Skip to content

Commit

Permalink
Adds CONTRIBUTORS file with instructions for contributing, running te…
Browse files Browse the repository at this point in the history
…sts, removes old empty tests
  • Loading branch information
bmcd committed Apr 15, 2016
1 parent 3662f13 commit e8abe1c
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 171 deletions.
49 changes: 49 additions & 0 deletions CONTRIBUTORS
@@ -0,0 +1,49 @@
## Deploying libraries to MavenLocal

- When working locally on backbone or skin, it can help to deploy the libraries to a local maven repo for testing
- Open the **ResearchStack project** in Android Studio
- Go to Run > Edit Configurations...
- Add new configuration (plus icon)
- Choose Gradle as the configuration type
- Set the name to "Deploy locally" or something
- Choose the **/build.gradle** file as the "Gradle project" field
- Add "install" to the tasks field
- Save
- Run that configuration and check ~/.m2 to see if it deployed
- Open your own Android Studio project and follow the instructions below to add these newly-deployed libraries as dependencies.

## Using the local library in a gradle Android app

After deploying the library module(s) that you need to your local machine using the above instructions, add it to your Android Studio project by doing this:

In the build.gradle file in your app folder, add the following to your root build.gradle so that it knows to search the ~/.m2 directory for dependencies:

```
allprojects {
repositories {
...
mavenLocal()
...
}
}
```

Then add the following entry to your dependencies in your app build.gradle:

```
dependencies {
...
compile 'org.researchstack:backbone:VERSION'
// or (if using Skin, you don't need Backbone since it is included)
compile 'org.researchstack:skin:VERSION'
...
}
```

## Running tests

Tests are located in the /backbone/src/test or /skin/src/test folder. Run the tests in Android Studio by right clicking on 'backbone' or 'skin' and clicking "Run 'All Tests'".

## Code Style

Contributors should import code_style_settings.jar into Android Studio and use the 'researchstack' Java code style. Make sure to 'Reformat Code' and 'Optimize Imports' using this style (but don't 'Reorganize Code') before submitting a pull request.
2 changes: 1 addition & 1 deletion skin/build.gradle
Expand Up @@ -4,7 +4,7 @@ apply plugin: 'me.tatarka.retrolambda'
apply plugin: 'com.neenbedankt.android-apt'
apply plugin: 'com.jfrog.bintray'

version = '0.9.0b2'
version = '1.0.0.rc1'

android {
compileSdkVersion 23
Expand Down
30 changes: 0 additions & 30 deletions skin/src/test/java/org/researchstack/skin/AesFileAccessTests.java

This file was deleted.

This file was deleted.

71 changes: 0 additions & 71 deletions skin/src/test/java/org/researchstack/skin/ScheduleHelperTest.java

This file was deleted.

0 comments on commit e8abe1c

Please sign in to comment.