Skip to content

Latest commit

 

History

History
85 lines (66 loc) · 3.52 KB

CONTRIBUTING.md

File metadata and controls

85 lines (66 loc) · 3.52 KB

Contributing

Note: This project is in the public domain. If you contribute any non-trivial patches or translations the following applies:

I dedicate any and all copyright interest in this software to the
public domain. I make this dedication for the benefit of the public at
large and to the detriment of my heirs and successors. I intend this
dedication to be an overt act of relinquishment in perpetuity of all
present and future rights to this software under copyright law.

Would you like to contribute code?

  1. Fork SeriesGuide. See further setup instructions below.
  2. Create a new branch (using GitHub or the command git checkout -b descriptive-branch-name dev) and make great commits + messages.
  3. Start a pull request. Reference existing issues when possible.

No code!

Repository structure

  • dev, the main development and test release branch.
  • master, the stable release branch. Always the latest stable version of SeriesGuide.

Setup

This project is built with Gradle, the Android Gradle plugin and uses jar and Maven dependencies.

  1. Clone this repository inside your working folder. I suggest only cloning the latest revision, like git clone --depth=1 https://github.com/UweTrottmann/SeriesGuide.git.
  2. Create the gradle.properties and fabric.properties files as noted below.
  3. Android Studio: import the settings.gradle file.

Before your first build create gradle.properties in the root directory (where settings.gradle is) and add the following values. They do not need to be valid if you do not plan to use that functionality:

# Credentials to publish the API jar
ossrhUsername=<your sonatype username>
ossrhPassword=<your sonatype password>

# API keys for integrated services
TMDB_API_KEY=<your api key>
TRAKT_CLIENT_ID=<your trakt client id>
TRAKT_CLIENT_SECRET=<your trakt client secret>
TVDB_API_KEY=<your api key>

# Play Store in-app billing public key
IAP_KEY_A=dummy
IAP_KEY_B=dummy
IAP_KEY_C=dummy
IAP_KEY_D=dummy

Also create SeriesGuide/fabric.properties for Crashlytics. You may use the dummy values below:

# crashlytics dummy values
apiSecret=0000000000000000000000000000000000000000000000000000000000000000
apiKey=0

Now build any variant of the pure flavor, for developing probably pureDebug (flavor + build type, see instructions about product flavors) defined in SeriesGuide/build.gradle.