Skip to content

Latest commit

 

History

History
73 lines (55 loc) · 2.74 KB

CONTRIBUTING.md

File metadata and controls

73 lines (55 loc) · 2.74 KB
Raw

Contributing

Would you like to contribute code?

  1. Fork SeriesGuide.
  2. git checkout -b descriptive-branch-name dev and make great commits + messages.
  3. Start a pull request against dev. Reference existing issues when possible.

No code!

Branch structure

The repository is made up of two main branches: master (stable) and dev (unstable).

  • master has the latest stable code, its tags are released as SeriesGuide on Google Play.
  • dev includes the latest unstable code from contributers (you!).

Setup

This project is built with Gradle, the Android Gradle plugin and uses jars or Maven dependencies. Clone this repository inside your working folder. Import the build.gradle file in the root folder into e.g. Android Studio. (You can also have a look at the build.gradle files on how the projects depend on another.)

Before your first build create the following files:

  • gradle.properties, add the following values (do not need to be valid if you do not plan to use that functionality):
ossrhUsername=<your sonatype username>
ossrhPassword=<your sonatype password>

TMDB_API_KEY=<your api key>
TRAKT_API_KEY=<your api key>
TVDB_API_KEY=<your api key>
TVTAG_CLIENT_ID=<your client id>
TVTAG_CLIENT_SECRET=<your client secret>

IAP_KEY_A=dummy
IAP_KEY_B=dummy
IAP_KEY_C=dummy
IAP_KEY_D=dummy
  • SeriesGuide/src/free/AndroidManifest.xml, add the following content:
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.battlelancer.seriesguide">

    <application>
        <!-- Crashlytics -->
        <meta-data android:name="com.crashlytics.ApiKey" android:value="0000000000000000000000000000000000000000"/>
    </application>
</manifest>

Now build any variant of the free flavor (flavor + build type, see instructions about product flavors) defined in SeriesGuide/build.gradle.