Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (35 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

59 lines (35 loc) · 1.44 KB

Contributing

Setup

Development OS

Please note that this project is only run using macOS so scripts will likely not work on other operating systems.

Bash

Some scripts may contain feature unavailable to the system version of bash. Install a newer version using Homebrew:

brew install bash

Manually building wgpu dependencies

wgpu-native is the underlying library used for WebGPU.

git submodule update --init --recursive
  • Build libraries
./scripts/build-android.sh
./scripts/build-ios.sh
  • Copy headers
./scripts/copy-headers.sh

Formatting native code

Please use ./scripts/format-cxx.sh to format c++ and Objective-C

Testing

Examples

All react-native-webgpu features have been built by providing an example to prove the feature works, and to prevent regressions. Please provide a working example when adding a new feature.

Check package

To test react-native-webgpu is packaged correctly, run ./scripts/test-package.sh. This will make a local npm package and build the example app for iOS, and Android on both architectures.

Check examples

You can run all examples using ./scripts/test-examples.sh. Check the generated screenshots for regressions.

This script requires that you build the examples first using ./scripts/test-package.sh