aniani/profanity
1
0
Fork 0
mirror of https://github.com/profanity-im/profanity.git synced 2024-12-04 14:46:46 -05:00
Code

Add unit tests section to CONTIBUTING.md

Browse Source 
And rename a header.
This commit is contained in:
Michael Vetter 2022-02-18 18:49:43 +01:00
parent fc1a24b9fa
commit d15f905d83
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@ -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.