1.7 KiB
1.7 KiB
Contributing
Guidelines
- Don't be rude.
Get started
- Fork & clone the repository
- Install dependencies
cd react-native-vision-camera yarn bootstrap
Read the READMEs in android/
and ios/
for a quick overview of the native development workflow.
You can also open VisionCamera in a quick online editor (github1s)
JS/TS
- Open the entire folder in Visual Studio Code
- Start the metro bundler in the
example/
directory usingyarn start
- Run either the iOS or Android project to test changes
Run
yarn check-js
to validate codestyle
iOS
- Open the
example/ios/VisionCameraExample.xcworkspace
file with Xcode - Change signing configuration to your developer account
- Select your device in the devices drop-down
- Hit run
Run
yarn check-ios
to validate codestyle
Android
- Open the
example/android/
folder with Android Studio - Start the metro bundler in the
example/
directory usingyarn start
- Select your device in the devices drop-down
- Hit run
Run
yarn check-android
to validate codestyle
Committing
We love to keep our codebases clean. To achieve that, we use linters and formatters which output errors when something isn't formatted the way we like it to be.
Before pushing your changes, you can verify that everything is still correctly formatted by running all linters:
yarn check-all
This validates Swift, Kotlin, C++ and JS/TS code:
$ yarn check-all
yarn run v1.22.10
Formatting Swift code..
Linting Swift code..
Linting Kotlin code..
Linting C++ code..
Linting JS/TS code..
All done!
✨ Done in 8.05s.