summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: bfc77ad)
raw | patch | inline | side by side (parent: bfc77ad)
author | Florian Forster <octo@collectd.org> | |
Tue, 24 Oct 2017 06:37:04 +0000 (08:37 +0200) | ||
committer | Florian Forster <octo@collectd.org> | |
Tue, 24 Oct 2017 06:37:04 +0000 (08:37 +0200) |
Also point to contrib/format.sh as the source of truth.
CONTRIBUTING.md | patch | blob | history |
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 791446a0a7b38af4a1b7a897aed3e4dc184ca7ac..11969ded040bb9b9309c6b55b9a363d5dfc766f8 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
* *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.