about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorMichael Vetter <jubalh@iodoru.org>2022-02-18 18:49:43 +0100
committerMichael Vetter <jubalh@iodoru.org>2022-02-18 18:49:43 +0100
commitd15f905d8300d68f476f99d87f9e8b4d895cc907 (patch)
tree42a77710484c32d084a3d6659e6188bc60903fb3
parentfc1a24b9fa79c9d531704d9ca9e68567734ac959 (diff)
downloadprofani-tty-d15f905d8300d68f476f99d87f9e8b4d895cc907.tar.gz
Add unit tests section to CONTIBUTING.md
And rename a header.
-rw-r--r--CONTRIBUTING.md8
1 files 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.