]> git.ipfire.org Git - thirdparty/collectd.git/commitdiff
docs/CONTRIBUTING.md: Rename "Bug" to "Fix"; improve wording.
authorFlorian Forster <octo@collectd.org>
Mon, 15 Jan 2024 18:57:36 +0000 (19:57 +0100)
committerFlorian Forster <octo@collectd.org>
Mon, 15 Jan 2024 18:57:36 +0000 (19:57 +0100)
Co-authored-by: Eero Tamminen <eero.t.tamminen@intel.com>
docs/CONTRIBUTING.md

index 13cdd4931d2ee13fb16bb61999ed25ad8c1e118c..7df030ad1110ac1e3a3289452d6300bbd4c1806f 100644 (file)
@@ -60,7 +60,7 @@ PRs need to be categorized into one of three categories:
     The code has new behavior. Performance and documentation improvements are
     considered features. These changes would typically go into a "feature
     release".
-*   **Bug**
+*   **Fix**
 
     The code fixes a bug, regression, or otherwise unintended behavior. These
     changes would typically go into a "patch" release.
@@ -95,9 +95,9 @@ ChangeLog: Foo plugin: A specific issue people had has been fixed.
 ```
 
 The summary must be on a line of its own, with a "ChangeLog:" prefix at the
-beginning of the line. The text should start with "Foo plugin" or "collectd"
-(when making changes to the daemon itself) to give the reader context for the
-information. Other common contexts are "collectd" for the core daemon, "Build
+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".