From d15f905d8300d68f476f99d87f9e8b4d895cc907 Mon Sep 17 00:00:00 2001 From: Michael Vetter Date: Fri, 18 Feb 2022 18:49:43 +0100 Subject: [PATCH] Add unit tests section to CONTIBUTING.md And rename a header. --- CONTRIBUTING.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 01c530cf..e52dbbd8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -71,8 +71,12 @@ what may have been staged/committed. If you're in a hurry you can add the `--no-verify` flag when issuing `git push` and the `pre-push` hook will be skipped. -## Pull Requests -Before submitting a Pull Request please run valgrind and the clang static code analyzer. +## Finding mistakes +Test your changes with the following tools to find mistakes. + +### unit tests + +Run `make check` to run the unit tests with your current configuration or `./ci-build.sh` to check with different switches passed to configure. ### valgrind We provide a suppressions file `prof.supp`. It is a combination of the suppressions for shipped with glib2, python and custom rules.