X-Git-Url: https://git.octo.it/?p=collectd.git;a=blobdiff_plain;f=CONTRIBUTING.md;h=11969ded040bb9b9309c6b55b9a363d5dfc766f8;hp=791446a0a7b38af4a1b7a897aed3e4dc184ca7ac;hb=b9b5e5d573d0011c4f3276e9b84b73ba4dd2e870;hpb=e56c1e570ff8d4e8fe732f9d74f11217479fdd7b diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 791446a0..11969ded 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,9 +30,11 @@ the mailing list have a tendency to fall through the cracks. * *Focus:* Fix *one thing* in your PR. The smaller your change, the faster it will be reviewed and merged. -* *Coding style:* Please run `clang-format -style=file -i $FILE` on new files. - For existing files, please blend into surrounding code, i.e. mimic the - coding style of the code around your changes. +* *Coding style:* Please run `clang-format -style=file -i $FILE` after editing + `.c`, `.h` and `.proto` files. If you don't want to install *clang-format* + locally or your version produces a different result than the formatting + check on Github, use `contrib/format.sh` to format files using the same web + service used by our check. * *Documentation:* New config options need to be documented in two places: the manpage (`src/collectd.conf.pod`) and the example config (`src/collectd.conf.in`). New plugins need to be added to the `README` file.