Skip to content

Latest commit

 

History

History
103 lines (66 loc) · 3.4 KB

CONTRIBUTING.md

File metadata and controls

103 lines (66 loc) · 3.4 KB
Raw

Incognia React Native

This is the repository for the Incognia React Native module. It exposes both Incognia and IncogniaTrial functionality to React Native apps.

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.

While developing, you can run the example app to test your changes. Any changes you make in your library's JavaScript code will be reflected in the example app without a rebuild. If you change any native code, then you'll need to rebuild the example app.

To start the packager:

yarn example start

To run the example app on Android:

yarn example android

To run the example app on iOS:

yarn example ios

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

To edit the Objective-C files, open example/ios/IncogniaExample.xcworkspace in XCode and find the source files at Pods > Development Pods > react-native-incognia.

To edit the Java files, open example/android in Android studio and find the source files at reactnativeincognia under Android.

Android dependency management

The sample project and the android folder use Gradle Lockfile for dependency locking. If you want to update the dependencies, first update the corresponding dependency in any build.gradle file and then run the following command:

make update-dependencies

The command will update the dependencies and the corresponding lock file.

Commit message convention

We follow the conventional commits specification for our commit messages:

  • fix: bug fixes, e.g. fix crash due to deprecated method.
  • feat: new features, e.g. add new method to the module.
  • refactor: code refactor, e.g. migrate from class components to hooks.
  • docs: changes into documentation, e.g. add usage example for the module..
  • chore: tooling changes, e.g. change CI config.

Our pre-commit hooks verify that your commit message matches this format when committing.

Linting

ESLint, Prettier, TypeScript

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

Our pre-commit hooks verify that the linter passes when committing.

Publishing to npm

We use release-it to make it easier to publish new versions.

To publish new versions, run the following:

yarn release

Scripts

The package.json file contains various scripts for common tasks:

  • yarn bootstrap: setup project by installing all dependencies and pods.
  • yarn typescript: type-check files with TypeScript.
  • yarn lint: lint files with ESLint.
  • yarn example start: start the Metro server for the example app.
  • yarn example android: run the example app on Android.
  • yarn example ios: run the example app on iOS.