Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
127 lines (90 loc) · 5.39 KB

CONTRIBUTING.md

File metadata and controls

127 lines (90 loc) · 5.39 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 environment

Core toolchain

Tool Minimum Recommended Notes
Node.js 20.19 22.x package.json requires >=20.19; .nvmrc pins v22
Yarn 4.11.0 4.11.0 Locked via packageManager field; uses node-modules linker
TypeScript ~5.9.2 ~5.9.2 Type checking & codegen
React 19.2.0 19.2.0 Pinned for development
React Native 0.83.2 0.83.2 Pinned for development
Expo SDK 55 55 All example apps use Expo SDK 55

iOS build environment

Requirement Value Notes
macOS Sequoia 15.6+ Minimum for Xcode 26
Xcode 26+ (Swift 6.2) expo-modules-core@55 requires Swift 6.2 Isolated Conformances
CocoaPods latest Managed by expo prebuild
iOS deployment target 16.0 RN 0.83 min_ios_version_supported

Important: Xcode 16.x cannot compile Expo SDK 55 iOS code.

Android build environment

Requirement Value Notes
JDK 17 Required by AGP 8.12.0 + Gradle 9.0.0
Gradle 9.0.0 Locked in gradle-wrapper.properties
AGP 8.12.0 Injected by React Native version catalog
Kotlin 2.1.20 Injected by Expo/RN version catalog
compileSdk / targetSdk API 36 (Android 16)
Build-Tools 36.0.0
NDK 27.1.12297006 For Hermes / Fabric JNI compilation
CMake 3.22.1
C++ standard C++20 Required by RN 0.83
minSdkVersion 24 (Android 7.0)

Note: Expo SDK 55 forces New Architecture (newArchEnabled=true); the old architecture is no longer supported.

Development workflow

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

yarn

Then initialize all packages (build outputs, codegen, etc.):

yarn prepare

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 root package.json file contains various scripts for common tasks:

  • yarn prepare: build all packages and run codegen across the monorepo.
  • yarn typecheck: type-check all packages and examples with TypeScript.
  • yarn lintcheck: lint all packages and examples with ESLint.
  • yarn format: format all files with Prettier.
  • yarn formatcheck: check formatting without writing changes.
  • yarn circular-dep-check: detect circular dependencies across all packages.
  • yarn clean: remove build artifacts from all packages and examples.

Workspace shortcuts let you run scripts in a specific package or example directly, e.g.:

  • yarn uikit <script>: run a script in react-native-chat-uikit.
  • yarn callkit <script>: run a script in react-native-chat-callkit.
  • yarn room <script>: run a script in react-native-chat-room.
  • yarn uikit-example start: start the Metro / Expo dev server for uikit-example.
  • yarn uikit-example android: run uikit-example on Android.
  • yarn uikit-example ios: run uikit-example on iOS.
  • yarn product-uikit-demo start: start the dev server for product-uikit-demo.
  • yarn room-example start: start the dev server for room-example.
  • yarn callkit-example start: start the dev server for callkit-example.

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.