mirror of https://github.com/profanity-im/profanity.git synced 2024-09-22 19:45:54 -04:00

Michael Vetter 66f9a6b721 Add clang-format file

People should run `make format` before doing a commit.
Fix https://github.com/profanity-im/profanity/issues/1396

2020-07-07 09:42:00 +02:00

866 B

Raw Blame History

Contributing to Profanity

Coding style

Follow the style already present ;-)

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.

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