Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
167 lines (110 loc) · 5.49 KB

CONTRIBUTING.md

File metadata and controls

167 lines (110 loc) · 5.49 KB

Contributing

Contributions are always welcome, no matter how large or small!

We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project. Before contributing, please read the code of conduct.

Development workflow

This project is a monorepo managed using Yarn workspaces. It contains the following packages:

  • The library package in the root directory.
  • A vanilla React Native example app in the example/ directory.
  • An Expo example app in the expo-example/ directory.

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

yarn

Since the project relies on Yarn workspaces, you cannot use npm for development.

This project uses Nitro Modules. If you're not familiar with how Nitro works, make sure to check the Nitro Modules Docs.

You need to run Nitrogen to generate the boilerplate code required for this project.

Run Nitrogen when you make changes to any *.nitro.ts files:

yarn nitrogen

This also runs automatically via the prepare script when you run yarn.

The example apps demonstrate usage of the library. You need to run one to test any changes you make.

Both are configured to use the local version of the library, so any changes you make to the library's source code will be reflected in the example apps. Changes to the library's JavaScript code will be reflected without a rebuild, but native code changes will require a rebuild.

To edit native code in Xcode or Android Studio, you can use:

yarn dev:ios      # Opens iOS project in Xcode
yarn dev:android  # Opens Android project in Android Studio

You can use various commands from the root directory to work with the project.

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 typecheck
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

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, e.g. 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, and Jest for testing.

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

Publishing to npm

We use release-it to make it easier to publish new versions. It handles common tasks like bumping version based on semver, creating tags and releases etc.

To publish new versions, run the following:

yarn release

Scripts

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

  • yarn: setup project by installing dependencies.
  • yarn typecheck: 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.

Swift code coverage

You can measure which Swift code in ios/ gets exercised by the harness tests. This uses LLVM source-based profiling and is opt-in.

# 1. Install pods with coverage enabled
cd example/ios && RIVE_SWIFT_COVERAGE=1 bundle exec pod install && cd ../..

# 2. Build the example app
yarn example build:ios

# 3. Run harness tests
yarn test:harness:ios

# 4. Extract coverage and print a summary
bash scripts/ios-coverage.sh

This produces coverage-swift.lcov (machine-readable) in the repo root. For an HTML report:

xcrun llvm-cov show \
  example/ios/build/Build/Products/Debug-iphonesimulator/RiveExample.app/RiveExample.debug.dylib \
  -instr-profile=coverage.profdata -arch arm64 -format=html -output-dir=coverage-html \
  -ignore-filename-regex='.*/(Pods|nitrogen|node_modules|DerivedData)/.*' \
  -sources "$PWD/ios/"
open coverage-html/index.html

To go back to normal (non-coverage) builds, just run pod install without the env var.

Sending a pull request

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.