CONTRIBUTING.md

Contributing

• Contributing
  • Contribute new modules
  • Contribute to Documentation
  • Contribute to Testing

Contribute new modules

If you want to add new opencv API/Module,

1. build libdartcv from source
2. add new C wrappers in src and make sure it is correctly build
3. add your .h file to ffigen in dartcv4 and run dart run ffigen --config ffigen.yaml
4. add corresponding dart code in lib
5. write testing code and test whether it works as expected

Note: C wrappers should be added to dartcv and dart bindings should be added to dartcv4

Contribute to Documentation

1. git clone https://github.com/rainyl/opencv_dart
2. open project in IDE and write doc strings above functions and classes in source codes.
3. follow the dart documentation recommendations, https://dart.dev/effective-dart/documentation

Contribute to Testing

For Windows:

1. git clone https://github.com/rainyl/opencv_dart
2. cd opencv_dart/packages/dartcv
3. install dependencies and add dynamic library path to PATH environment variable.
4. now write new dart tests and place them in test/ directory.
5. run dart test
6. (Optional) add the absolute path of opencv_dart/windows to PATH environment variable, which can ebable the testing sidebar of VSCode.

Other platforms are similar.