Skip to content
This repository has been archived by the owner on Nov 8, 2023. It is now read-only.

Commit

Permalink
Added some debugging tips to Contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
arpd authored and jvoisin committed Oct 26, 2017
1 parent 5c84131 commit 0c33346
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,23 @@ git checkout -b 325-kill-sql-injections
Just type `make coverage` or `make debug`, the testsuite should be run
automatically. Please do add tests if you're fixing a bug or adding a new feature.

#### Debugging failures in the test suite

If your changes have introduced run-time failures in the test-suite, you can
easily attach your debugger to analyse that particular test case by doing the
following:
```
make debug
cd src/
make test TESTS="-v --show-diff"
```
Adding the `-v` flag will provide more information (e.g. the full command used
to run that particular test case), and `--show-diff` will (if the test case
failed) show the difference between what was returned, and what was expected.

If you'd like to see what other options are available for debugging test cases,
you can add `-h` to the `TESTS` variable.

### 4. Did you find a bug?

* **Ensure the bug was not already reported** by
Expand Down

0 comments on commit 0c33346

Please sign in to comment.