mirror of
https://github.com/profanity-im/profanity.git
synced 2024-06-09 21:30:42 +00:00
23 lines
701 B
Markdown
23 lines
701 B
Markdown
|
# Contributing to Profanity
|
||
|
|
|
||
|
|
## Coding style
|
||
|
|
Follow the style already present ;-)
|
||
|
|
|
||
|
|
## Pull Requests
|
||
|
|
Before submitting a Pull Request please run valgrind and the clang static code analyzer.
|
||
|
|
|
||
|
|
### valgrind
|
||
|
|
We provide a suppressions file `prof.supp`. It is a combination of the suppressions for shipped with glib2, python and custom rules.
|
||
|
|
|
||
|
|
`G_DEBUG=gc-friendly G_SLICE=always-malloc valgrind --tool=memcheck --track-origins=yes --leak-check=full --leak-resolution=high --num-callers=30 --show-leak-kinds=definite --log-file=profval --suppressions=prof.supp ./profanity`
|
||
|
|
|
||
|
|
### clang
|
||
|
|
|
||
|
|
Running the clang static code analyzer helps improving the quality too.
|
||
|
|
|
||
|
|
```
|
||
|
|
make clean
|
||
|
|
scan-build make
|
||
|
|
scan-view ...
|
||
|
|
```
|