From f0f9d67279ac18e1c784a232185d42c019a22a45 Mon Sep 17 00:00:00 2001 From: Lars Danau Date: Thu, 2 Apr 2026 21:13:47 +0200 Subject: [PATCH 1/2] docs: update CONTRIBUTING docs to match scripts --- CONTRIBUTING.md | 39 +++++++++++++-------------------------- 1 file changed, 13 insertions(+), 26 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2b1197d..20213d7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,7 +31,7 @@ To edit the Java or Kotlin files, open `example/android` in Android studio and f You can use various commands from the root directory to work with the project. -To start the packager: +To start the example app packager: ```sh yarn example start @@ -49,44 +49,31 @@ To run the example app on iOS: yarn example ios ``` -To confirm that the app is running with the new architecture, you can check the Metro logs for a message like this: - -```sh -Running "EaseExample" with {"fabric":true,"initialProps":{"concurrentRoot":true},"rootTag":1} -``` - -Note the `"fabric":true` and `"concurrentRoot":true` properties. - -Make sure your code passes TypeScript: - -```sh -yarn typecheck -``` - -To check for linting errors, run the following: +To run linting and type checks: ```sh yarn lint ``` -To fix formatting errors, run the following: +To check formatting: ```sh -yarn lint --fix +yarn format:check ``` - - ### Scripts -The `package.json` file contains various scripts for common tasks: +The root `package.json` contains these common scripts: -- `yarn`: setup project by installing dependencies. -- `yarn typecheck`: type-check files with TypeScript. -- `yarn lint`: lint files with [ESLint](https://eslint.org/). +- `yarn`: install dependencies for the workspace. +- `yarn format:check`: check Prettier and clang-format. +- `yarn format:write`: write Prettier and clang-format fixes. +- `yarn lint`: run ESLint and TypeScript checks for the library and example app. +- `yarn test`: run the Jest test suite. +- `yarn prepare`: build the library with `react-native-builder-bob`. - `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 android`: run the example app on Android. ### Sending a pull request @@ -95,7 +82,7 @@ The `package.json` file contains various scripts for common tasks: When you're sending a pull request: - Prefer small pull requests focused on one change. -- Verify that linters and tests are passing. +- Verify that formatting, linting, tests, and any relevant example app checks 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. From 799e2b4f10beb2d3f14ef8f6e810acff441457eb Mon Sep 17 00:00:00 2001 From: Lars Danau Date: Thu, 2 Apr 2026 21:19:34 +0200 Subject: [PATCH 2/2] fix: mismatch ios .xcworkspace file --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 20213d7..52f1c7f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,7 +25,7 @@ The [example app](/example/) demonstrates usage of the library. You need to run It is 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 app. Changes to the library's JavaScript code will be reflected in the example app without a rebuild, but native code changes will require a rebuild of the example app. -If you want to use Android Studio or Xcode to edit the native code, you can open the `example/android` or `example/ios` directories respectively in those editors. To edit the Objective-C or Swift files, open `example/ios/EaseExample.xcworkspace` in Xcode and find the source files at `Pods > Development Pods > react-native-ease`. +If you want to use Android Studio or Xcode to edit the native code, you can open the `example/android` or `example/ios` directories respectively in those editors. To edit the Objective-C or Swift files, open `example/ios/Ease.xcworkspace` in Xcode and find the source files at `Pods > Development Pods > react-native-ease`. To edit the Java or Kotlin files, open `example/android` in Android studio and find the source files at `react-native-ease` under `Android`.