Skip to content

Latest commit

 

History

History
64 lines (42 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

64 lines (42 loc) · 2.71 KB

Contributing to the Aerobase Android SDK

The Aerobase Android SDK is part of the Aerobase project, see the Community Page for general guidelines for contributing to the project.

This document details specifics for contributions to the Android SDK.

Issue tracker

The tracking of issues for the AeroGear Android SDK is done in the Aerobase Android Project.

See the Aerobase JIRA Usage and Guidelines Guide for information on how the issue tracker relates to contributions to this project.

Asking for help

Whether you're contributing a new feature or bug fix, or simply submitting a ticket, the Aerobase team is available for technical advice or feedback. You can reach us at [@AerobaseOrg] or at the aerobase google group -- both are actively monitored.

Developing the Android SDK

Prerequisites

Ensure you have the following installed in your machine:

Cloning the repository

git clone https://github.com/aerobase/aerobase-android-sdk.git
cd aerobase-android-sdk/

Installing dependencies and building the SDK

Run the following command to install the dependencies for the Android SDK:

./gradlew install

In Android Studio, go to Tools > Android > Sync Project With Gradle Files.

See the Gradle Documentation for more information on Gradle and the Gradle Wrapper

Adding Our Style Guide to Android Studio

We are using spotless to enforce our style guidelines on the project. You may invoke spotless manually by running ./gradlew spotlessCheck. If there are errors spotless will prompt you to run ./gradlew spotlessApply and auto fix them. If your code fails to meet the style guidelines it will fail. However, if you are using Android Studio you may make use of the Eclipse Code Formatter.

Publish to maven repo

  • Make sure ~/.gradle/gradle.properties file exists with the following entries:
NEXUS_USERNAME=Your Nexus user name
NEXUS_PASSWORD=Your Nexus password
signing.keyId=You can use gpg -K to get it
signing.password=The passphrase used to protect your private key
signing.secretKeyRingFile=~/.gnupg/secring.gpg

For further signing plugin details refer to https://docs.gradle.org/current/userguide/signing_plugin.html