CONTRIBUTING.md

Contributing

FAQ

How to update the HyperTrack SDK version and make a release?

1. Update SDK version constant

   • Android
     • Change <plugin name>_HyperTrackSDKVersion in:
       • sdk/android/gradle.properties
       • plugin_android_activity_service_google/android/gradle.properties
       • plugin_android_location_services_google/android/gradle.properties
       • plugin_android_location_services_google_19_0_1/android/gradle.properties
       • plugin_android_push_service_firebase/android/gradle.properties
   • iOS
     • Change s.dependency 'HyperTrack', '**version**' in:
       • sdk/hypertrack-sdk-react-native.podspec

2. Increment wrapper version

Change version value in:

• hypertrack-sdk-react-native version in sdk/package.json
• hypertrack-sdk-react-native-plugin-android-activity-service-google in plugin_android_activity_service_google/package.json
• hypertrack-sdk-react-native-plugin-android-location-services-google in plugin_android_location_services_google/package.json
• hypertrack-sdk-react-native-plugin-android-location-services-google-19-0-1 in plugin_android_location_services_google_19_0_1/package.json
• hypertrack-sdk-react-native-plugin-android-push-service-firebase in plugin_android_push_service_firebase/package.json

3. Update CHANGELOG

   • Add the release link to the bottom

4. Update badge in README

5. Do the release dry run with just release and verify that the release is correct

6. Commit and merge to master

7. Create a Github repo release

   • Release title should be the current version tag

8. Run just release publish to publish the packages to npm:

How to change build config

Android

Change Android build config in gradle.properties of respective plugins

Development workflow

To get started with the project, run yarn in the root directory to install the required dependencies for each package:

yarn

While it's possible to use npm, the tooling is built around yarn, so you'll have an easier time if you use yarn for development.

Make sure your code passes TypeScript and ESLint. Run the following to verify:

yarn typescript
yarn lint

To fix formatting errors, run the following:

yarn lint --fix

Linting and tests

ESLint, Prettier, TypeScript

We use TypeScript for type checking, ESLint with Prettier for linting and formatting the code, and Jest for testing.

Sending a pull request

Working on your first pull request? You can learn how from this free series: How to Contribute to an Open Source Project on GitHub.

When you're sending a pull request:

• Prefer small pull requests focused on one change.
• Verify that linters and tests are passing.
• Review the documentation to make sure it looks good.
• Follow the pull request template when opening a pull request.
• For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.