Skip to content

Latest commit

 

History

History
63 lines (49 loc) · 3.24 KB

CONTRIBUTING.md

File metadata and controls

63 lines (49 loc) · 3.24 KB
Raw

Contributing to maps-app-android

  1. Getting Involved
  2. Reporting Bugs
  3. Contributing Code

Getting Involved

Third-party patches are absolutely essential on our quest to create the best maps app on android. However, they're not the only way to get involved with the development of maps-app-android. You can help the project tremendously by discovering and reporting bugs, improving documentation, helping others with GitHub issues, tweeting to @ArcGIS_Runtime, and spreading the word about mapps-app-android and the ArcGIS Runtime SDK for Android among your colleagues and friends.

Reporting Bugs

Before reporting a bug on the project's issues page, first make sure that your issue is caused by maps-app-android, not your application code. Second, search through the reported issues for your issue, and if it's already reported, just add any additional details in the comments.

After you made sure that you've found a new maps-app-android bug, here are some tips for creating a helpful report that will make fixing it much easier and quicker:

  • Be very clear about your issue in the title.
  • Include hardware & android api version info in the description.
  • Offer plenty of details to help others understand the problem.
  • If possible, create a simple reproducible test case to demonstrates the bug.

Contributing Code

System Requirements

System requirements of the Android SDK are provided here. Below are the basic developer requirements to working with ArcGIS Runtime SDK For Android in Eclipse:

Setting up your dev environment

Install and setup your Android Studio developer environment here. Once installed you can work with the project directly

Fork the repo

If you haven't already, got to https://github.com/Esri/maps-app-android and click the Fork button.

Clone the repo

Clone your fork.

Command line Git

  1. Clone the Maps App Android
  2. cd into the maps-app-android folder

Configure remotes

Move into the directory the cloning process just created (should be maps-app-android), then make sure your local git knows about all the remotes and branches.

$ cd maps-app-android
# Changes the active directory in the prompt to the newly cloned "maps-app-android" directory
$ git remote add upstream https://github.com/Esri/maps-app-android.git
# Assigns the original repository to a remote called "upstream"
$ git fetch upstream
# Pulls in changes not present in your local repository, without modifying your files