Skip to content

Commit

Permalink
chore: fix misleading contributing guide (#2564)
Browse files Browse the repository at this point in the history
## Description

We recommended to run `yarn prepare` in `react-navigation` submodule,
which is not existend (for some time now I believe).

## Changes

Updated the `yarn submodules` script & fixed the contributing guide.


## Test code and steps to reproduce

Clone fresh repo & follow contributing guide - it should work now. 

## Checklist

- [ ] Ensured that CI passes
  • Loading branch information
kkafar authored Dec 10, 2024
1 parent a77252a commit 8b9b9f2
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 6 deletions.
8 changes: 3 additions & 5 deletions guides/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,7 @@ To begin with, let install all dependencies:

1. `yarn`
2. `yarn submodules`
3. `(cd react-navigation && yarn prepare)`
4. `cd Example`
4. `cd Example` or `cd FabricExample` (depending on architecture you want to work on)
5. `yarn`
6. `yarn start` – make sure to start metro bundler before building the app in Android Studio

Expand All @@ -108,10 +107,9 @@ To begin with, let install all dependencies:

1. `yarn`
2. `yarn submodules`
3. `(cd react-navigation && yarn prepare)`
4. `cd Example`
4. `cd Example` or `cd FabricExample`
5. `yarn`
6. `(cd ios && pod install)`
6. `(cd ios && pod install && cd ../)`
7. `yarn start` – make sure to start metro bundler before building the app in XCode.

and open `react-native-screens/Example/ios/ScreensExample.xcworkspace` with XCode.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": "4.4.0-rc.0",
"description": "Native navigation primitives for your React Native app.",
"scripts": {
"submodules": "git submodule update --init --recursive && (cd react-navigation && yarn)",
"submodules": "git submodule update --init --recursive && (cd react-navigation && yarn && yarn build && cd ../)",
"check-types": "tsc --noEmit",
"start": "react-native start",
"test:unit": "jest --passWithNoTests",
Expand Down

0 comments on commit 8b9b9f2

Please sign in to comment.