CONTRIBUTING.md

Contributing

(More details coming...)

Run example/ app locally

Installation

# 1. Install dependencies
yarn install # For tests, lint, etc
cd example/
yarn install

# 2. Install from local
yarn install:local
# removes "file:../" (does not work with RN-metro)

Running app in android

yarn android
yarn start

Sync changes

When you make changes to the react-native-week-view/ package, you need to manually sync the code with the example/ app to see the changes. After each change, run yarn sync and reload the app.

Profile performance on android

• General RN guides: https://reactnative.dev/docs/profiling#profiling-android-ui-performance-with-systrace

• Systrace was deprecated in android-SDK platform-tools v33.0.1. Instead, try one of:

  • Android profiler: https://developer.android.com/studio/profile/android-profiler
  • Android gpu inspector: https://developer.android.com/agi/start
  • Perfetto: https://perfetto.dev/docs/

• To use systrace, run the following:

cd example
yarn android:release # evaluate performance in release version (__DEV__ === false)

# Open the app in the emulator

# Run systrace with:
/path/to/android-sdk/platform-tools/systrace/systrace.py --time 10 -o ../traces/<some-filename>.html sched gfx view -a com.example

# Interact with the app for 10 seconds, then check trace.html in Google Chrome

Known issues:

• UI thread info is detailed, but JS thread info may not be complete, see here: facebook/react-native#26032