Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (33 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

47 lines (33 loc) · 1.33 KB

InstantSearch android logo

Contributing Guide

A note about the branches used in this project:

  • develop is for the major version in active development
  • master is for the main current stable version

You should do the dev and PR according to the target version. No new features will be implemented on the master version.

Development

You can use our example applications while developing the library to test the new changes.

git clone git@github.com:algolia/instantsearch-android-examples.git
cd instantsearch-android-examples
gradle installDebug

Code

The code for InstantSearch Android is located in src.

Test

We have unit tests written with JUnit:

To run the tests, set your environment with your Algolia credentials and run the script. Since the tests are creating and removing indices, DO NOT use your production application.

ALGOLIA_APPLICATION_ID=XXXX
ALGOLIA_API_KEY=XXXX
./run_tests.sh