2019-07-23 07:25:17 +00:00
|
|
|
# Contributing to Profanity
|
|
|
|
|
|
|
|
|
|
## Coding style
|
|
|
|
|
Follow the style already present ;-)
|
|
|
|
|
|
2020-07-07 07:42:00 +00:00
|
|
|
To make this easier for you we created a `.clang-format` file.
|
|
|
|
|
You'll need to have `clang-format` installed.
|
|
|
|
|
|
|
|
|
|
Then just run `make format` before you do any commit.
|
|
|
|
|
|
2020-07-07 07:51:47 +00:00
|
|
|
It might be a good idea to add a git pre-commit hook.
|
|
|
|
|
So git automatically runs clang-format before doing a commit.
|
|
|
|
|
|
|
|
|
|
You can add the following snippet to `.git/hooks/pre-commit`:
|
|
|
|
|
```
|
|
|
|
|
for f in $(git diff --cached --name-only)
|
|
|
|
|
do
|
|
|
|
|
clang-format -i $f
|
|
|
|
|
done
|
|
|
|
|
```
|
|
|
|
|
|
2019-07-23 07:25:17 +00:00
|
|
|
## 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 ...
|
|
|
|
|
```
|
