X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=CONTRIBUTING.md;h=68c338e82182051b8bf99a6ae0dd68ab211c0447;hb=f7f2ade4b22244ad0451da904bf7c9e2c9415358;hp=11969ded040bb9b9309c6b55b9a363d5dfc766f8;hpb=66fd3303352c526255ab4bde256361244e26b259;p=collectd.git diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 11969ded..68c338e8 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 summary in the initial pull description. +This information is used to automatically generate release notes. Follow this +style: + +``` +ChangeLog: Foo plugin: A specific issue people had has been fixed. +``` + +The summary should 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)