docs: Update CONTRIBUTING
This commit is contained in:
parent
7772fc3588
commit
290a20f8e3
@ -2,7 +2,8 @@
|
||||
|
||||
## Guidelines
|
||||
|
||||
1. Don't be rude.
|
||||
1. Don't be an asshole.
|
||||
2. Don't waste anyone's time.
|
||||
|
||||
## Get started
|
||||
|
||||
@ -10,6 +11,7 @@
|
||||
2. Install dependencies
|
||||
```
|
||||
cd react-native-vision-camera
|
||||
cd package
|
||||
yarn bootstrap
|
||||
```
|
||||
|
||||
@ -39,7 +41,11 @@ Read the READMEs in [`android/`](android/README.md) and [`ios/`](ios/README.md)
|
||||
1. Open the `example/android/` folder with Android Studio
|
||||
2. Start the metro bundler in the `example/` directory using `yarn start`
|
||||
3. Select your device in the devices drop-down
|
||||
4. Hit run
|
||||
4. Once your device is connected, make sure it can find the metro bundler's port:
|
||||
```
|
||||
adb reverse tcp:8081 tcp:8081
|
||||
```
|
||||
6. Hit run
|
||||
|
||||
> Run `yarn check-android` to validate codestyle
|
||||
|
||||
|
@ -7,8 +7,7 @@
|
||||
"android": "react-native run-android",
|
||||
"ios": "react-native run-ios",
|
||||
"start": "react-native start",
|
||||
"setup": "cd ios && bundle install",
|
||||
"pods": "cd ios && bundle exec pod install",
|
||||
"pods": "cd ios && pod install",
|
||||
"lint": "eslint .",
|
||||
"lint-ci": "yarn lint -f ../node_modules/@firmnav/eslint-github-actions-formatter/dist/formatter.js",
|
||||
"typescript": "tsc --noEmit"
|
||||
|
@ -35,7 +35,7 @@
|
||||
"build": "bob build",
|
||||
"release": "release-it",
|
||||
"pods": "cd example && yarn pods",
|
||||
"bootstrap": "yarn && cd example && yarn && yarn setup && yarn pods",
|
||||
"bootstrap": "yarn && cd example && yarn && yarn pods",
|
||||
"check-android": "scripts/ktlint.sh && scripts/clang-format.sh",
|
||||
"check-ios": "scripts/swiftlint.sh && scripts/swiftformat.sh && scripts/clang-format.sh",
|
||||
"check-js": "yarn lint --fix && yarn typescript",
|
||||
|
Loading…
Reference in New Issue
Block a user