docs/CONTRIBUTING.md: Change formulation examples to discourage verbatim copying.

Co-authored-by: Eero Tamminen <eero.t.tamminen@intel.com>
This commit is contained in:
Florian Forster
2024-01-22 11:03:39 +01:00
parent 625488e1a4
commit d7806f3007

View File

@@ -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 &lt;describe impact&gt; has been fixed", "a feature
&lt;describe impact&gt; 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