Skip to content

Latest commit

 

History

History
120 lines (82 loc) · 4.16 KB

CONTRIBUTING.md

File metadata and controls

120 lines (82 loc) · 4.16 KB
Raw

Contributing

We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project.

Development workflow

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

yarn bootstrap

While developing, you can run the example app to test your changes.

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

Remember to add tests for your change if possible. Run the unit tests by:

yarn test

The are also end-to-end tests. First you will have to build the app and then run the tests:

# Start the server (*note there's a separate e2e command*
yarn example start:e2e

# iOS
yarn example e2e:build:ios
yarn example e2e:test:ios

# Android
yarn example e2e:build:android
yarn example e2e:test:android

To edit the Objective-C / Swift files, open example/ios/AnalyticsReactNativeExample.xcworkspace in XCode and find the source files at Pods > Development Pods > @segment/analytics-react-native.

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

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..
  • test: adding or updating tests, eg add integration tests using detox.
  • chore: tooling changes, e.g. change CI config.

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

Linting and tests

ESLint, Prettier, TypeScript

We use TypeScript for type checking, ESLint with Prettier for linting and formatting the code, Jest for unit testing and Detox for end-to-end tests.

Our pre-commit hooks verify that the linter and tests pass when committing.

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 test: run unit tests with Jest.
  • 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.
  • yarn example e2e:build:ios: builds the example app using detox
  • yarn example e2e:test:ios: runs the e2e on a simulator(headless if not ran manually)
  • yarn example e2e:build:android: builds the example app using detox
  • yarn example e2e:test:android: runs the e2e on an emulator
  • yarn example ios:deeplink: opens the ios app via deep link (example app must already be installed)
  • yarn example android:deeplink: opens the Android app via deep link (example app must already be installed)

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.