Skip to content

Commit

Permalink
docs: a few updates to contribution guidelines
Browse files Browse the repository at this point in the history
Signed-off-by: Ron Evans <[email protected]>
  • Loading branch information
deadprogram committed Mar 23, 2018
1 parent 46b2d03 commit a3c61f6
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# How to contribute

We would like your help to make this project better, so we appreciate any contributions. See if one of the following descriptions matches you.
Thank you for your interest in improving GoCV.

We would like your help to make this project better, so we appreciate any contributions. See if one of the following descriptions matches your situation:

### Newcomer to GoCV, to OpenCV, or to computer vision in general

We'd love to get your feedback on getting started with GoCV. Run into any difficulty, confusion, or anything else? We want to know, so we can help the next people. Please open a Github issue with your questions, or get in touch directly with us.
We'd love to get your feedback on getting started with GoCV. Run into any difficulty, confusion, or anything else? You are not alone. We want to know about your experience, so we can help the next people. Please open a Github issue with your questions, or get in touch directly with us.

### Something in GoCV is not working as you expect

Expand Down Expand Up @@ -53,4 +55,19 @@ XYZ(p1, p2)
XYZWithParams(p2, p2, p3, p4)
```

Thank you!
## How to run tests

You will need to run `source env.sh` or `env.cmd` depending on your OS one time before you can run the Go unit tests.

Then you can run:

```
go test .
go test ./contrib/.
```

If you are using the Intel CV SDK, you can run those tests using:

```
go test ./pvl/.
```

0 comments on commit a3c61f6

Please sign in to comment.