X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=CONTRIBUTING.md;h=e4d683c9e68cb2925901caac3c9c56b348097497;hb=e19d1f0affb0b68e11c9ed3448b3d5a663bb0049;hp=f2475666086a5013026c26205db62bc9e5a4650e;hpb=135ff51aea84dd8131d38e0cf0d3b18853cdb935;p=collectd.git

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f2475666..e4d683c9 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -30,12 +30,14 @@ 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`).
+    (`src/collectd.conf.in`). New plugins need to be added to the `README` file.
 *   *Continuous integration:* Once your PR is created, our continuous
     integration environment will try to build it on a number of platforms. If
     this reports a failure, please investigate and fix the problem. We will at
@@ -49,6 +51,26 @@ the mailing list have a tendency to fall through the cracks.
     entries to `src/types.db`, you should talk to us early in the design
     process.
 
+### ChangeLog
+
+All PRs need to have a one-line description in the initial pull request body.
+This information is used to automatically generate release notes. Follow this
+style:
+
+```
+Foo plugin: A specific issue people had has been fixed.
+```
+
+Start with "Foo plugin" to give the reader context for the information. Other
+common prefixes are "collectd" for the core daemon and "Build system". Use past
+tense and passive voice the for remainder, e.g. "a bug has been fixed", "a
+feature has been added".
+
+Some PRs should not be added to the release notes, e.g. changes to project
+internal documentation (such as this file). Those changes are not interesting
+for external users of the project and would reduce the value of the release
+notes. Maintainers may use the `Unlisted Change` label to mark those PRs.
+
 ## Other resources
 
 *   [Mailing list](http://mailman.verplant.org/listinfo/collectd)