CONTRIBUTING.md

Contributing to React Native Brownfield

Project setup

Run yarn in the root of the repository to install all dependencies.

Depending on your needs, you may need to install CocoaPods in the example React Native iOS app: cd apps/RNApp/ios && pod install.

Contributing changes

After contributing your changes, please make sure to add a changeset describing your changes. This will help us in publishing new versions.

Publishing to npm

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

Scripts

• lint - runs linting on all JS/TS source files in the monorepo [Turbo]
• gradle-plugin:lint - runs linting on the Brownfield Gradle plugin source code
• typecheck - runs TypeScript type checking on all TS source files in the monorepo [Turbo]
• build - runs all build* tasks in the Turbo repo - see below for more details [Turbo]
• dev - runs all dev tasks in all workspaces
• brownfield:plugin:publish:local - publishes the Brownfield Gradle plugin to your local Maven repository for testing purposes
• build:brownfield - builds the React Native Brownfield package (packages/react-native-brownfield) [Turbo]
• build:docs - builds the documentation site (docs/) [Turbo]
• build:example:android-rn - builds the example React Native app for Android (apps/RNApp/android)
• build:example:ios-rn - builds the example React Native app for iOS (apps/RNApp/ios)
• build:example:android-consumer:expo - builds the example native Android consumer (apps/AndroidApp) app's flavor consuming the Expo RN app (apps/ExpoApp) artifact
• • build:example:android-consumer:vanilla - builds the example native Android consumer (apps/AndroidApp) app's flavor consuming the vanilla RN app (apps/RNApp) artifact
• build:example:ios-consumer - builds the example native Apple consumer app (apps/AppleApp)