Skip to content

Latest commit

 

History

History
77 lines (49 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

77 lines (49 loc) · 2.75 KB
Raw

Development and Testing

How to run the project locally

  • Clone the repository:
git https://github.com/amadeus4dev/amadeus-android.git
  • Install latest Android Studio version
  • Open project's root folder build.gradle with Android Studio File > Open
  • For authentication: Open the .gradle folder (root user) and edit/create the gradle.properties file. Add your API Key and API Secret in the gradle.properties:
amadeus.api.key="REPLACE_BY_YOUR_API_KEY"
amadeus.api.secret="REPLACE_BY_YOUR_API_SECRET"

Running tests

To run the tests using a terminal.

cd amadeus-android
./gradlew testDebugUnitTest --tests 'com.amadeus.android.unit*'

Using library locally

You can publish a new version of the library locally and directly use it with one of your project or the Android Hotel Demo app.

Increment the number inside gradle.properties file.

# publication properties

VERSION=X.X.X
...

Publish your new version locally.

./gradlew publishToMavenLocal

You can now use this new version in your build.gradle file.

    implementation 'com.amadeus:amadeus-android:X.X.X'

How to contribute to the Amadeus Android SDK

Did you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Do you intend to add a new feature or change an existing one?

  • Suggest your change in a new issue and start writing code.

  • Make sure your new code does not break any tests and include new tests.

  • With good code comes good documentation. Try to copy the existing documentation and adapt it to your needs.

  • Close the issue or mark it as inactive if you decide to discontinue working on the code.

Do you have questions about the source code?