Skip to content

Latest commit

 

History

History
93 lines (58 loc) · 2.34 KB

CONTRIBUTING.md

File metadata and controls

93 lines (58 loc) · 2.34 KB
Raw

Contributing

Requirements

  • Node.JS
  • Cordova
  • Some IDE (Visual Studio Code for example)
  • Xcode (iOS) and Android Studio (Android)
  • CocoaPods (iOS) (sudo gem install cocoapods)
  • ios-deploy (for deploying an app on an iOS device) (brew install ios-deploy)
  • iOS 11 or higher on a test device.
  • run-s (https://www.npmjs.com/package/run-s)

Building

On the root folder of Sentry Cordova run the following commands:

all environments

  • yarn build

MacOS additional command

  • make (this will build the carthage for Sentry cocoa)

Testing on a sample project

On the sample project folder, load your local Sentry Cordova with the following commands:

  • yarn platforms:add
  • cordova plugin add '../'

If succeeded, Sentry wizzard will be invoked and your project configured with Sentry Cordova.

Addionally, if you want to remove Sentry Cordova you can run the following command:

cordova plugin remove sentry-cordova # same command works for removing the local sentry cordova from your project

To build your sample project:

cordova build ios # Build the iOS solution
cordova build android # Build the Android solution
cordova build # Build both Android and iOS

To test your code you can run the following command:

iOS

cordova run ios

Or you can open your project on Xcode and build there

open ./platforms/ios/projectname.xcworkspace/

NOTE: If you pretend to debug your code, it's recommended to have a Real iPhone/iPad.

NOTE2: If you plan to run on Apple simulators, to make life easier, close all simulators before running any run`build` command.

Android

cordova emulate android

Or open the Android folder inside o the Sample app

Updating Native Libraries

When updating a native library, please make sure to validate with a sample app to fix any break change or broken code.

iOS

go to 'src/ios/Carfile' and update the version number.

make sure to fix or warn about any break changes with the altered version before submiting a new Pull Request.

Android

go to 'plugin.xml' and update the SENTRY_ANDROID_SDK_VERSION version number.

Updating Sentry Cordova on a test app

the process of updating or testing Sentry Cordova on different versions consists on first removing the previous installed plugin and then installing the desired on afterward.