X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=CONTRIBUTING.md;h=e4d683c9e68cb2925901caac3c9c56b348097497;hb=ee771cb0c5df11fad393de41571effb9708f0873;hp=11969ded040bb9b9309c6b55b9a363d5dfc766f8;hpb=358bf39b09f69220fc8e1b6c2fe98e5e185e3364;p=collectd.git diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 11969ded..e4d683c9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -51,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)