railbird/react-native-vision-camera
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
ef40b1db23
react-native-vision-camera/CONTRIBUTING.md
alexstanbury ef40b1db23
docs: Fix Frame Processor install step and QualityPrioritization Order (#451) 
* fix: switched incorrect property ordering for qualityPrioritization options

fix: added extra step required for create frame processing plugin on Android

* fix: adjusted the highlighted line

* chore: added guidelines on how to generate and check docs updares

* chore: change instructions so they aren't so unnecessarily wordy! :P
2021-09-24 10:15:26 +02:00

2.0 KiB
Raw Blame History

Contributing

Guidelines

  1. Don't be rude.

Get started

  1. Fork & clone the repository
  2. 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

  1. Open the entire folder in Visual Studio Code
  2. Start the metro bundler in the example/ directory using yarn start
  3. Run either the iOS or Android project to test changes

Run yarn check-js to validate codestyle

iOS

  1. Open the example/ios/VisionCameraExample.xcworkspace file with Xcode
  2. Change signing configuration to your developer account
  3. Select your device in the devices drop-down
  4. Hit run

Run yarn check-ios to validate codestyle

Android

  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

Run yarn check-android to validate codestyle

Docs

  1. Edit the relevant file, it may be easiest to search for what you're editing to find the right file
  2. Install all dependencies by running yarn inside the docs folder

Run yarn start to generate the docs, you can then view them in your browser to confirm your changes

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.