Skip to content

Commit b79f16c

Browse files
committed
update ci and contribution
1 parent 2188b9f commit b79f16c

File tree

5 files changed

+34
-23
lines changed

5 files changed

+34
-23
lines changed

.circleci/config.yml

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ jobs:
124124
command: curl -Ls "https://get.maestro.mobile.dev" | bash
125125

126126
- run:
127-
working_directory: example/test
127+
working_directory: examples/example/test
128128
name: Build android
129129
command: yarn run build:android
130130

@@ -141,10 +141,10 @@ jobs:
141141
- run:
142142
name: Install app on emulator
143143
command: |
144-
adb install -r ~/project/example/android/app/build/outputs/apk/release/app-release.apk
144+
adb install -r ~/project/examples/example/android/app/build/outputs/apk/release/app-release.apk
145145
146146
- run:
147-
working_directory: example/test
147+
working_directory: examples/example/test
148148
name: Run UI Tests
149149
command: yarn run test:android
150150

@@ -161,25 +161,25 @@ jobs:
161161
- <<: *setup_env_file
162162

163163
- run:
164-
working_directory: example/e2e
164+
working_directory: examples/example/e2e
165165
name: Install Maestro
166166
command: curl -Ls "https://get.maestro.mobile.dev" | bash
167167

168168
- restore_cache:
169169
keys:
170-
- pod-dependencies-{{ checksum "~/project/example/ios/Podfile" }}
170+
- pod-dependencies-{{ checksum "~/project/examples/example/ios/Podfile" }}
171171
- run:
172-
working_directory: example/ios
172+
working_directory: examples/example/ios
173173
name: Install Pods
174174
command: pod install
175175

176176
- save_cache:
177-
key: pod-dependencies-{{ checksum "~/project/example/ios/Podfile" }}
177+
key: pod-dependencies-{{ checksum "~/project/examples/example/ios/Podfile" }}
178178
paths:
179-
- ~/project/example/ios/Pods
179+
- ~/project/examples/example/ios/Pods
180180

181181
- run:
182-
working_directory: example/test
182+
working_directory: examples/example/test
183183
name: Build
184184
command: yarn run build:ios
185185

@@ -193,10 +193,10 @@ jobs:
193193
- run:
194194
name: Install app on simulator
195195
command: |
196-
xcrun simctl install booted ~/project/example/test/build/Build/Products/Release-iphonesimulator/IntercomReactNativeExampleUI.app
196+
xcrun simctl install booted ~/project/examples/example/test/build/Build/Products/Release-iphonesimulator/IntercomReactNativeExampleUI.app
197197
198198
- run:
199-
working_directory: example/test
199+
working_directory: examples/example/test
200200
name: Run UI Tests
201201
command: yarn run test:ios
202202

CONTRIBUTING.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,12 @@ yarn
1212

1313
> While it's possible to use [`npm`](https://github.com/npm/cli), the tooling is built around [`yarn`](https://classic.yarnpkg.com/), so you'll have an easier time if you use `yarn` for development.
1414
15-
While developing, you can run the [example app](/example/) to test your changes. Any changes you make in your library's JavaScript code will be reflected in the example app without a rebuild. If you change any native code, then you'll need to rebuild the example app.
15+
While developing, you can run the example apps to test your changes:
16+
17+
- **[Standard Example](/examples/example/)** - Full React Native app (Runs on Old React Native Architecture)
18+
- **[Expo Example](/examples/expo-example/)** - Expo-based app (Runs on New React Native Architecture)
19+
20+
Any changes you make in your library's JavaScript code will be reflected in the example apps without a rebuild. If you change any native code, then you'll need to rebuild the example apps.
1621

1722
To start the packager:
1823

@@ -51,9 +56,9 @@ Remember to add tests for your change if possible. Run the unit tests by:
5156
yarn test
5257
```
5358

54-
To edit the Objective-C files, open `example/ios/IntercomReactNativeExample.xcworkspace` in XCode and find the source files at `Pods > Development Pods > intercom-react-native`.
59+
To edit the Objective-C files, open `examples/example/ios/IntercomReactNativeExample.xcworkspace` in XCode and find the source files at `Pods > Development Pods > intercom-react-native`.
5560

56-
To edit the Kotlin files, open `example/android` in Android studio and find the source files at `intercomreactnative` under `Android`.
61+
To edit the Kotlin files, open `examples/example/android` in Android studio and find the source files at `intercomreactnative` under `Android`.
5762

5863
### Commit message convention
5964

@@ -104,7 +109,7 @@ The `package.json` file contains various scripts for common tasks:
104109
105110
When you're sending a pull request:
106111

107-
### Make sure that Pull Request target is `dev` branch.
112+
### Make sure that Pull Request target is `dev` branch
108113

109114
- Prefer small pull requests focused on one change.
110115
- Verify that linters and tests are passing.
@@ -188,11 +193,11 @@ Community leaders will follow these Community Impact Guidelines in determining t
188193
### Attribution
189194

190195
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
191-
available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
196+
available at [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).
192197

193198
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
194199

195200
[homepage]: https://www.contributor-covenant.org
196201

197202
For answers to common questions about this code of conduct, see the FAQ at
198-
https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
203+
[https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1097,7 +1097,14 @@ ___
10971097

10981098
## Usage
10991099

1100-
[Check example app](./examples/example/src/App.tsx)
1100+
### Example Apps
1101+
1102+
We provide two example applications to help you get started:
1103+
1104+
1. **[Standard Example](./examples/example/)** - A full-featured React Native app demonstrating all Intercom features (Runs Old React Native Architecture)
1105+
2. **[Expo Example](./examples/expo-example/)** - An Expo-based example (Runs New React Native Architecture)
1106+
1107+
[View the main example app code](./examples/example/src/App.tsx)
11011108
___
11021109

11031110
## Troubleshooting

examples/expo-example/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This is an [Expo](https://expo.dev) project demonstrating the integration of @in
1717

1818
1. Install dependencies:
1919
```bash
20-
yarn install
20+
pnpm install
2121
```
2222

2323
## Configuration
@@ -61,15 +61,15 @@ This is an [Expo](https://expo.dev) project demonstrating the integration of @in
6161

6262
2. Start the development server:
6363
```bash
64-
yarn start
64+
pnpm start
6565
```
6666

6767
### Expo Go (Limited functionality)
6868

6969
Note: Push notifications and some native features may not work in Expo Go.
7070

7171
```bash
72-
yarn start
72+
pnpm start
7373
```
7474

7575
Then scan the QR code with Expo Go app on your device.

tsconfig.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@
2626
"target": "esnext",
2727
},
2828
"exclude": [
29-
"examples",
30-
"sandboxes"
29+
"examples"
3130
]
3231
}

0 commit comments

Comments
 (0)