You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+6-27Lines changed: 6 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,21 +11,23 @@ This project is a monorepo managed using [Yarn workspaces](https://yarnpkg.com/f
11
11
- The library package in the root directory.
12
12
- An example app in the `example/` directory.
13
13
14
-
To get started with the project, run `yarn` in the root directory to install the required dependencies for each package:
14
+
To get started with the project, make sure you have the correct version of [Node.js](https://nodejs.org/) installed. See the [`.nvmrc`](./.nvmrc) file for the version used in this project.
15
+
16
+
Run `yarn` in the root directory to install the required dependencies for each package:
15
17
16
18
```sh
17
19
yarn
18
20
```
19
21
20
-
> Since the project relies on Yarn workspaces, you cannot use [`npm`](https://github.com/npm/cli) for development.
22
+
> Since the project relies on Yarn workspaces, you cannot use [`npm`](https://github.com/npm/cli) for development without manually migrating.
21
23
22
24
> If you have `node` installed, then to install Yarn simply run `corepack enable`
23
25
24
26
The [example app](/example/) demonstrates usage of the library. You need to run it to test any changes you make.
25
27
26
28
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.
27
29
28
-
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/LocationStatusExample.xcworkspace` in XCode and find the source files at `Pods > Development Pods > react-native-location-status`.
30
+
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/LocationStatusExample.xcworkspace` in Xcode and find the source files at `Pods > Development Pods > react-native-location-status`.
29
31
30
32
To edit the Java or Kotlin files, open `example/android` in Android studio and find the source files at `react-native-location-status` under `Android`.
31
33
@@ -49,29 +51,6 @@ To run the example app on iOS:
49
51
yarn example ios
50
52
```
51
53
52
-
By default, the example is configured to build with the old architecture. To run the example with the new architecture, you can do the following:
53
-
54
-
1. For Android, run:
55
-
56
-
```sh
57
-
ORG_GRADLE_PROJECT_newArchEnabled=true yarn example android
58
-
```
59
-
60
-
2. For iOS, run:
61
-
62
-
```sh
63
-
cd example/ios
64
-
RCT_NEW_ARCH_ENABLED=1 pod install
65
-
cd -
66
-
yarn example ios
67
-
```
68
-
69
-
If you are building for a different architecture than your previous build, make sure to remove the build folders first. You can run the following command to cleanup all build folders:
70
-
71
-
```sh
72
-
yarn clean
73
-
```
74
-
75
54
To confirm that the app is running with the new architecture, you can check the Metro logs for a message like this:
76
55
77
56
```sh
@@ -106,7 +85,7 @@ We follow the [conventional commits specification](https://www.conventionalcommi
106
85
-`fix`: bug fixes, e.g. fix crash due to deprecated method.
107
86
-`feat`: new features, e.g. add new method to the module.
108
87
-`refactor`: code refactor, e.g. migrate from class components to hooks.
109
-
-`docs`: changes into documentation, e.g. add usage example for the module..
88
+
-`docs`: changes into documentation, e.g. add usage example for the module.
110
89
-`test`: adding or updating tests, e.g. add integration tests using detox.
0 commit comments