Skip to content
Permalink
Browse files
contributing: add section about testing changes
  • Loading branch information
Snaipe committed Jan 31, 2018
1 parent ba21a46 commit 293bff7575b8b4437e7b42e58a20ce1a31859585
Showing with 26 additions and 0 deletions.
  1. +26 −0 CONTRIBUTING.md
@@ -41,6 +41,32 @@ the style checker on the region. Note that this feature should be used
*exceptionally*, and that the maintainer will always have the last word regarding
stylistic choices that cannot pass the style check.

## Testing

Testing your changes is important. When you submit a pull request, the CI system
will trigger a build to test your changes on various platforms; however, to speed
up the initial development process, it's best to test it locally at first.

The following commands should get you going with a workable test system:

```
$ mkdir -p build && cd $_
$ cmake -DDEV_BUILD=1 -DCTESTS=1 ..
$ cmake --build . --target criterion_tests
$ ctest
```

Make sure you have cram 0.7 installed before running ctest; Criterion uses cram
internally for its system tests:

```
$ pip install --user cram==0.7
or alternatively
$ sudo pip install cram==0.7
```

## Translations

* You can contribute new translation files for output messages, on the

0 comments on commit 293bff7

Please sign in to comment.