railbird/react-native-vision-camera
9
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Update CONTRIBUTING

Browse Source
This commit is contained in:
Marc Rousavy 2023-09-01 18:32:23 +02:00
parent 7772fc3588
commit 290a20f8e3
3 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@ -2,7 +2,8 @@
## Guidelines ## Guidelines
1. Don't be rude. 1. Don't be an asshole.
2. Don't waste anyone's time.
## Get started ## Get started
@ -10,6 +11,7 @@
2. Install dependencies 2. Install dependencies
``` ```
cd react-native-vision-camera cd react-native-vision-camera
cd package
yarn bootstrap 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 1. Open the `example/android/` folder with Android Studio
2. Start the metro bundler in the `example/` directory using `yarn start` 2. Start the metro bundler in the `example/` directory using `yarn start`
3. Select your device in the devices drop-down 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 > Run `yarn check-android` to validate codestyle

3
package/example/package.json
View File

@ -7,8 +7,7 @@
"android": "react-native run-android", "android": "react-native run-android",
"ios": "react-native run-ios", "ios": "react-native run-ios",
"start": "react-native start", "start": "react-native start",
"setup": "cd ios && bundle install", "pods": "cd ios && pod install",
"pods": "cd ios && bundle exec pod install",
"lint": "eslint .", "lint": "eslint .",
"lint-ci": "yarn lint -f ../node_modules/@firmnav/eslint-github-actions-formatter/dist/formatter.js", "lint-ci": "yarn lint -f ../node_modules/@firmnav/eslint-github-actions-formatter/dist/formatter.js",
"typescript": "tsc --noEmit" "typescript": "tsc --noEmit"

2
package/package.json
View File

@ -35,7 +35,7 @@
"build": "bob build", "build": "bob build",
"release": "release-it", "release": "release-it",
"pods": "cd example && yarn pods", "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-android": "scripts/ktlint.sh && scripts/clang-format.sh",
"check-ios": "scripts/swiftlint.sh && scripts/swiftformat.sh && scripts/clang-format.sh", "check-ios": "scripts/swiftlint.sh && scripts/swiftformat.sh && scripts/clang-format.sh",
"check-js": "yarn lint --fix && yarn typescript", "check-js": "yarn lint --fix && yarn typescript",