From: Florian Forster Date: Mon, 22 Jan 2024 10:03:39 +0000 (+0100) Subject: docs/CONTRIBUTING.md: Change formulation examples to discourage verbatim copying. X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=d7806f30072ea98538b055433ca1ed1e697c4cda;p=thirdparty%2Fcollectd.git docs/CONTRIBUTING.md: Change formulation examples to discourage verbatim copying. Co-authored-by: Eero Tamminen --- diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 719f18b62..a2c51dab7 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -103,7 +103,8 @@ beginning of the line. To give the reader context for the information, the text should start with "${name} plugin" when making changes to a plugin, and "collectd" for the core daemon changes. Other common contexts are "Build system", and "Documentation". Use past tense and passive voice the for -remainder, e.g. "a bug has been fixed", "a feature has been added". +remainder, e.g. "a bug <describe impact> has been fixed", "a feature +<describe impact> has been added". Some PRs should be excluded from the release notes, e.g. changes to project internal documentation (such as this file). Those changes are not interesting